Standalone CLI

OctoGuide also provides a standalone octoguide CLI you can run outside GitHub Actions. octoguide can analyze a GitHub contribution and preview what rule violations that the OctoGuide action would report for it. This CLI to use the same underlying API as also used in the GitHub Action.

npm

npx octoguide https://github.com/OctoGuide/bot/issues/19

pnpm

pnpx octoguide https://github.com/OctoGuide/bot/issues/19

yarn

yarn dlx octoguide https://github.com/OctoGuide/bot/issues/19

Found 0 reports. Great! ✅

Note

The octoguide CLI only logs pretty-printed reports back in your terminal. It does not create comments or otherwise post any data to GitHub.

The octoguide CLI takes in one required positional argument for the activity to be scanned. That activity may also be provided as a shorthand locator:

• Omitting the https://github.com: npx octoguide OctoGuide/bot/issues/19
• Omitting the owner, which defaults to your logged in user: npx octoguide bot/issues/19

Flags

--config

Which preset config to use, as either:

• recommended (default)
• strict

npx octoguide OctoGuide/bot/issues/19 --config strict