Add the latest version of
bithound to your package.json:
npm install bithound --save-dev
bin/bithound provides two cli commands:
check (git url || repo token) Checks bitHound for failing files or dependencies.
token Opens your browser to the repo settings page of the current project.
If you include
node_modules/.bin in your
$PATH, you can run this cli with:
Otherwise, run it with:
Attempts to retrieve the latest status of failing criteria for a repo.
This command can be used to check the status of both public and private repos.
For public repos, use the raw git url of the repo. It will look similar to:
For private repos, use your repo token provided by bitHound. It will look similar to:
token command for how to get this value.
Run the check command as follows:
bithound check <git url | repo token>
You may optionally pass the specific branch and sha through the
--sha options, respectively. However, this is
designed to work inside a CI and, as such, the
check command will attempt to pick up the branch and sha from the CI environment variables
when a push event is detected by the CI.
If analysis is in progress, this command will poll until analysis is complete and report the results.
Your repo token can be found on your repo settings page under Integrations or by running
bithound token. In addition, you may also configure your repo's failing criteria on that settings page.
This command takes you to your Integrations section of the repo settings page for the repo that bitHound is currently found to be a dependency of. Think of it as a shortcut to discovering your repo token.
Please note: This command requires git to be installed in order to properly identify the repo remote origin.