Documentation Index
Fetch the complete documentation index at: https://docs.codeant.ai/llms.txt
Use this file to discover all available pages before exploring further.
Global Options
codeant --version # Show CLI version
codeant --help # Show help for all commands
codeant <command> --help # Show help for a specific command
Authentication
login
Authenticate with CodeAnt AI via browser-based OAuth.
logout
Sign out and remove stored credentials.
set-token
Store an authentication token for an SCM platform.
codeant set-token <remote> <token>
github, gitlab, bitbucket, azure
Examples:
codeant set-token github ghp_xxxxxxxxxxxx
codeant set-token gitlab glpat-xxxxxxxxxxxx
codeant set-token bitbucket ATBB_xxxxxxxxxxxx
codeant set-token azure xxxxxxxxxxxx
set-codeant-api-key
Manually set the CodeAnt AI API key (alternative to codeant login).
codeant set-codeant-api-key <key>
get-codeant-api-key
Display the currently stored CodeAnt API key (masked — shows first and last 4 characters).
codeant get-codeant-api-key
set-telemetry
Enable or disable anonymous usage analytics (PostHog).
codeant set-telemetry <true|false>
get-telemetry
Show current telemetry status.
Code Scanning
All scanning commands share a common set of options for controlling scan scope and file filtering.
Common Scan Options
These options apply to secrets:
| Option | Description |
|---|
--staged | Scan only staged files (default) |
--all | Scan all changed files compared to base branch |
--committed | Scan only unpushed commits |
--uncommitted | Scan all uncommitted changes (staged + unstaged + untracked) |
--last-commit | Scan files from the last commit |
--last-n-commits <n> | Scan files from the last n commits (max 5) |
--base <branch> | Compare against a specific base branch |
--base-commit <commit> | Compare against a specific commit SHA |
--include <patterns> | Comma-separated glob patterns to include files |
--exclude <patterns> | Comma-separated glob patterns to exclude files |
* matches any characters except /** matches any characters including /*.{js,ts} matches multiple extensions (brace expansion is supported)- Multiple patterns:
--exclude 'test/**,dist/**'
secrets
Scan code for exposed secrets, API keys, and credentials.
codeant secrets [options]
| Option | Description |
|---|
--fail-on <level> | Fail threshold: HIGH, MEDIUM, or all (default: HIGH) |
| Level | Description |
|---|
HIGH | High confidence — likely a real secret |
MEDIUM | Medium confidence — may require manual review |
FALSE_POSITIVE | Detected but likely not a real secret (always ignored) |
0 — No blocking secrets found (or only false positives)1 — Secrets detected that match the --fail-on threshold
Examples:
# Scan staged files (default)
codeant secrets
# Scan all changed files on this branch
codeant secrets --all
# Scan the last commit
codeant secrets --last-commit
# Scan last 3 commits
codeant secrets --last-n-commits 3
# Fail on HIGH and MEDIUM confidence secrets
codeant secrets --fail-on MEDIUM
# Fail on all secrets except false positives
codeant secrets --fail-on all
# Filter by file patterns
codeant secrets --include '**/*.js' --exclude 'node_modules/**,*.test.js'
✗ 2 secret(s) found!
src/config.js
Line 5: AWS Access Key (HIGH)
Line 12: API Key (HIGH)
Remove secrets before committing.
⚠ 1 potential secret(s) found (ignored)
Ignored (false positives):
src/example.js
Line 10: Generic Secret (FALSE_POSITIVE)
✓ Commit allowed (only false positives found)
Analytics
track
Send an analytics event to CodeAnt. Primarily used by integrations (Claude Code skills, CI systems, etc.) to record usage events.
| Option | Description |
|---|
--event <name> | Event name (required), e.g., skill_invoked, suggestions_applied |
--props <json> | JSON string of event properties (default: {}) |
codeant track --event skill_invoked --props '{"skill":"codeant-review","source":"claude-code"}'
Configuration
set-base-url
Set a custom API base URL for self-hosted CodeAnt deployments.
codeant set-base-url <url>
codeant set-base-url https://api.your-company.com
get-base-url
Display the current API base URL and where it’s configured.
Configuration File
All configuration is stored in ~/.codeant/config.json.
Configuration Keys:
| Key | Description |
|---|
apiKeyV2 | CodeAnt AI API token (set via codeant login or codeant set-codeant-api-key) |
baseUrl | API base URL (set via codeant set-base-url) |
githubToken | GitHub token (set via codeant set-token github) |
gitlabToken | GitLab token (set via codeant set-token gitlab) |
bitbucketToken | Bitbucket token (set via codeant set-token bitbucket) |
azureDevOpsToken | Azure DevOps token (set via codeant set-token azure) |
githubBaseUrl | GitHub Enterprise API URL |
gitlabBaseUrl | Self-hosted GitLab URL |
bitbucketBaseUrl | Bitbucket Server URL |
telemetryEnabled | Boolean — enable or disable anonymous analytics |
| Variable | Description |
|---|
CODEANT_API_URL | Override API base URL |
CODEANT_API_TOKEN | Override API authentication token |
CODEANT_TELEMETRY_DISABLED | Set to 1 or true to disable analytics |
GITHUB_TOKEN / GH_TOKEN | GitHub authentication |
GITHUB_API_URL / GH_ENTERPRISE_URL | GitHub Enterprise API URL |
GITLAB_TOKEN | GitLab authentication |
GITLAB_URL / GITLAB_HOST | Self-hosted GitLab URL |
BITBUCKET_TOKEN | Bitbucket authentication |
BITBUCKET_URL / BITBUCKET_SERVER_URL | Bitbucket Server URL |
AZURE_DEVOPS_TOKEN / AZURE_DEVOPS_PAT | Azure DevOps authentication |
- Environment variables (highest)
- Platform CLI tools (
gh, glab)
- Config file (
~/.codeant/config.json)
- Default values
