Git Product home page Git Product logo

gaudit's Introduction

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 <team> [permission] - List of repos available to a team
  gaudit diff <old> <new> - 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

gaudit's People

Contributors

cotarg avatar mmcquillan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.