1
0
mirror of https://github.com/strongdm/comply synced 2024-07-02 23:14:22 +00:00
comply/README.md

77 lines
2.0 KiB
Markdown
Raw Normal View History

2018-05-19 00:27:11 +00:00
![Comply](https://github.com/strongdm/comply/blob/master/logo.png)
2018-05-15 21:13:11 +00:00
Comply is a SOC2-focused compliance automation tool:
- **Policy Generator**: markdown-powered **document pipeline** for publishing auditor-friendly **policy documents**
- **Ticketing Integration**: automate compliance throughout the year via your existing **ticketing system**
2018-05-15 21:13:11 +00:00
- **SOC2 Templates**: open source policy and procedure **templates** suitable for satisfying a SOC2 audit
# Installation
macOS:
2018-05-15 23:03:58 +00:00
`brew tap strongdm/comply; brew install comply`
2018-05-15 21:13:11 +00:00
2018-05-19 00:29:29 +00:00
Linux:
[Download latest release](https://github.com/strongdm/comply/releases)
2018-05-15 21:13:11 +00:00
Go users:
`go get github.com/strongdm/comply`
# Get Started
Start with `comply init`:
```
$ mkdir my-company
$ cd my-company
$ comply init
```
Once `comply init` is complete, just `git init` and `git push` your project to a new repository. You're ready to begin editing the included policy boilerplate text.
2018-05-15 21:13:11 +00:00
# Discussion
Join us in [Comply Users](https://join.slack.com/t/comply-users/shared_invite/enQtMzU3MTk5MDkxNDU4LTMwYzZkMjA4YjQ2YTM5Zjc0NTAyYWY5MDBlOGMwMzRmZTk5YzBlOTRiMTVlNGRlZjY1MTY1NDE0MjY5ZjYwNWU)
# Screenshots
2018-05-19 00:32:54 +00:00
[Demo video](https://vimeo.com/270257486)
2018-05-15 21:13:11 +00:00
## Start a Project
![screencast 1](sc-1.gif)
## Build PDFs
![screencast 4](sc-4.gif)
![pdf example](pdf-example.png)
## Track Policy Coverage
![screencast 3](sc-2.gif)
## Dashboard
![screencast 2](sc-3.gif)
## CLI
```
NAME:
comply - policy compliance toolkit
USAGE:
comply [global options] command [command options] [arguments...]
COMMANDS:
2018-05-18 21:42:55 +00:00
init initialize a new compliance repository (interactive)
build, b generate a static website summarizing the compliance program
procedure, proc create ticket by procedure ID
scheduler create tickets based on procedure schedule
serve live updating version of the build command
sync sync ticket status to local cache
todo list declared vs satisfied compliance controls
help, h Shows a list of commands or help for one command
2018-05-15 21:13:11 +00:00
```