Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hashicorp/gaudit
Github Audit Tool for Organizations
https://github.com/hashicorp/gaudit
cli github golang
Last synced: 6 days ago
JSON representation
Github Audit Tool for Organizations
- Host: GitHub
- URL: https://github.com/hashicorp/gaudit
- Owner: hashicorp
- License: mit
- Created: 2019-06-05T16:23:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-13T21:00:51.000Z (over 3 years ago)
- Last Synced: 2024-09-19T06:13:18.254Z (15 days ago)
- Topics: cli, github, golang
- Language: Go
- Homepage:
- Size: 30.3 KB
- Stars: 34
- Watchers: 18
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# gaudit - Github Audit Tool for Organizations
This is a command line tool to help you organize and analyze your github
repositories in your organization. You can create some basic rules to look
for conditions in your repositories and output the results as a CSV.
### Commands
```
gaudit
gaudit update - Update working list of github repos
gaudit list - List of working github repos
gaudit team [permission] - List of repos available to a team
gaudit diff - Difference since last update
gaudit details [filter] - Detail list of github repos
gaudit analyze - Analyze rules against working repos
gaudit results [--verbose] - Show results of analysis
gaudit append - Creates or updates the append file
gaudit stats - Summarizes statistics data on the audit
gaudit csv - Outputs to csv format
```
### Environment Variables
`GAUDIT_GITHUB_TOKEN` - The Github Token for your account.
`GAUDIT_ORGANIZATION` - Specify the Github Organization (does not work with personal accounts)
`GAUDIT_STORAGE` - The file to store state in (defaults to audit.store)
`GAUDIT_RULES` - Rules file for analysis (defaults to rules.yml)
`GAUDIT_APPEND` - Append file for annotating (defaults to append.yml)
`GAUDIT_DEBUG` - Set debug mode (defaults to false)
### Rules File
You can create a rules file to analyze your Github repositories.
Example:
```
-
name: CircleCI Config
action: exists
resource: .circleci/config.yml
-
name: TravisCI Config
action: not_exists
resource: .travis.yml
-
name: README File
action: exists
resource: README.md
-
name: License
action: exists
resource: LICENSE
-
name: Copyright Notice
action: exists
resource: NOTICE.md
type: public
-
name: Copyright Date
action: contains
resource: NOTICE.md
match: 2019
type: public
```
### Releases
NEXT
- Added rules results to details
- Added rules results to stats
- Updated diff to exclude size/updated date
- Updated the stats date output
- Added list of teams on each repo
- Added team command to list by team
- Added team output for details and csv
- Switching Org ownership
v0.1.1
- Added a Stats command
v0.1.0
- Initial release