Quickstart

Preview a public repository in one command

No account, API key, global install, clone, or zip is required. The result includes a private-link preview that expires after 24 hours.

1. Open an interactive Terminal or PowerShell window

Replace owner/repo with a public GitHub repository, paste the command, and press Enter:

npx --yes codecordon@0.3.2 scan https://github.com/owner/repo

2. Fetch public source

CodeCordon downloads the public repository server-side. It never asks for GitHub credentials or private-repository access.

3. Scan without login

Interactive public-repository previews need no account or API key and are limited to three per hour.

4. Read the result

CodeCordon prints the grade, severity counts, exact files and lines, and whether your configured security gate passed.

How to read the result

Exit 0 · gate passed

The configured known-pattern threshold passed. This is not proof that the application is secure.

Exit 1 · findings failed the gate

The scan completed. Review the named rules, exact files, and lines before changing code.

Exit 2 · scan could not run

Read the error above the exit. Confirm Node.js 20+, an interactive terminal, and a public GitHub URL.

First-scan troubleshooting

  • No free preview: run the public-repository command in an interactive Terminal or PowerShell window. Automated and CI runs require a Pro API key.
  • Repository rejected: use the full URL of a public GitHub repository. Private repositories are not fetched with GitHub credentials.
  • Preview limit reached: anonymous public previews are limited to three per hour; retry after the window resets.
  • Unexpected finding: inspect the rule, file, line, and snippet. A match still needs human review and may be scanner noise.
Report a reproducible CLI problem

Need to scan a local or private project?

Local-folder CLI scans and CI enforcement require Pro. Sign in once, create an API key in Settings, and CodeCordon saves it in a user-only config file.

npx --yes codecordon@0.3.2 scan /path/to/project
Open Settings

Useful commands

npx --yes codecordon@0.3.2 login

Replace an expired or revoked saved API key.

npx --yes codecordon@0.3.2 logout

Remove the saved API key from this computer.