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.
CodeAnt provides two interfaces for exploring scan results — an interactive terminal UI for humans, and a set of CLI subcommands for scripts and AI agents.
Interactive UI: scan-center
Browse scan results interactively in your terminal.
Launches a full-terminal interactive UI. Navigate through:
- Connection — Select your organization/connection
- Repository — Pick a repository
- Scan — Select a scan (latest or historical)
- Result type — Choose a finding category:
- Security Issues (SAST), Anti-Patterns, Docstring Issues, Complex Functions
- SCA, SBOM, Secrets, IaC, Dead Code
- Dismissed Alerts, Dismissed Secrets
No options. Use arrow keys and Enter to navigate.
Agent / Script Interface: scans
The scans subcommands expose the same data as structured output, designed for use in CI pipelines, AI agents, and scripts.
codeant scans <subcommand> [options]
scans orgs
List authenticated organizations.
Output: Returns your connections and user email.
scans repos
List repositories for an organization.
codeant scans repos [options]
| Option | Description |
|---|
--org <org> | Organization name (auto-picked when only one is authenticated) |
Examples:
# List repos (auto-selects org if only one)
codeant scans repos
# List repos for a specific org
codeant scans repos --org my-org
scans history
Show scan history for a repository.
codeant scans history --repo <owner/repo> [options]
| Option | Description |
|---|
--repo <repo> | (required) Repository in owner/repo format |
--branch <name> | Filter by branch name |
--since <iso> | Show scans since ISO date (e.g. 2024-01-01) |
--limit <n> | Max results (default: 20) |
Examples:
# Show last 20 scans for a repo
codeant scans history --repo acme/backend
# Filter to a specific branch
codeant scans history --repo acme/backend --branch main
# Show scans since a date
codeant scans history --repo acme/backend --since 2024-06-01
scans get
Show scan metadata and a severity/category summary. Does not include individual findings.
codeant scans get --repo <owner/repo> [options]
| Option | Description |
|---|
--repo <repo> | (required) Repository in owner/repo format |
--scan <sha> | Specific commit SHA to use |
--branch <name> | Resolve latest scan on this branch |
--types <list> | Comma-separated scan types (default: all) |
--quiet | Suppress progress output |
Scan types: sast, anti_patterns, docstring, complex_functions, sca, sbom, secrets, iac, dead_code, all
Examples:
# Get latest scan summary for a repo
codeant scans get --repo acme/backend
# Get scan for a specific commit
codeant scans get --repo acme/backend --scan abc1234
# Get latest scan on a branch, only SAST and secrets
codeant scans get --repo acme/backend --branch main --types sast,secrets
scans results
Fetch full scan findings for a repository.
codeant scans results --repo <owner/repo> [options]
| Option | Description |
|---|
--repo <repo> | (required) Repository in owner/repo format |
--scan <sha> | Specific commit SHA to use |
--branch <name> | Resolve latest scan on this branch |
--types <list> | Comma-separated types: sast, sca, secrets, iac, dead_code, sbom, anti_patterns, docstring, complex_functions, all (default: all) |
--severity <list> | Filter by severity (e.g. critical,high) |
--path <glob> | Filter by file path glob |
--check <regex> | Filter by check ID or name (regex) |
--include-dismissed | Include dismissed findings (excluded by default) |
--format <fmt> | Output format: json, sarif, csv, md, table (default: json) |
--output <path> | Write output to file instead of stdout |
--fields <list> | Project findings to a subset of fields (comma-separated) |
--limit <n> | Max findings per page (default: 100) |
--offset <n> | Pagination offset (default: 0) |
--fail-fast | Exit 3 on first category fetch failure |
--no-color | Disable ANSI color (auto-disabled when not a TTY) |
--quiet | Suppress progress output on stderr |
Examples:
# Fetch all findings (JSON)
codeant scans results --repo acme/backend
# Fetch only critical and high severity findings
codeant scans results --repo acme/backend --severity critical,high
# Fetch SAST findings only
codeant scans results --repo acme/backend --types sast
# Filter to a specific file path
codeant scans results --repo acme/backend --path 'src/**/*.ts'
# Filter by check name using regex
codeant scans results --repo acme/backend --check 'sql-injection'
# Output as SARIF to a file
codeant scans results --repo acme/backend --format sarif --output results.sarif
# Include dismissed findings
codeant scans results --repo acme/backend --include-dismissed
# Paginate through results
codeant scans results --repo acme/backend --limit 50 --offset 100
# Project only specific fields
codeant scans results --repo acme/backend --fields id,severity,message,path
Exit codes:
| Code | Meaning |
|---|
0 | Success |
1 | General error |
3 | Category fetch failure (with --fail-fast) |
scans dismissed
List dismissed alerts for a repository.
codeant scans dismissed --repo <owner/repo> [options]
| Option | Description |
|---|
--repo <repo> | (required) Repository in owner/repo format |
--analysis-type <type> | Analysis type: security or secrets (default: security) |
Examples:
# List dismissed security alerts
codeant scans dismissed --repo acme/backend
# List dismissed secrets alerts
codeant scans dismissed --repo acme/backend --analysis-type secrets
scans start-scan
Trigger a new analysis run for a repository.
codeant scans start-scan [options]
All options are optional — repo, branch, and commit are auto-detected from the local git context.
| Option | Description |
|---|
--repo <repo> | Repository in owner/repo format |
--branch <name> | Branch to scan |
--commit <sha> | Commit SHA to scan |
--include <paths> | Comma-separated glob patterns to include |
--exclude <paths> | Comma-separated glob patterns to exclude |
Examples:
# Zero-config — auto-detects repo, branch, and latest commit
codeant scans start-scan
# Explicit repo and branch
codeant scans start-scan --repo CodeAnt-AI/codeant-cli --branch main
# Scan only specific files
codeant scans start-scan --branch main --include "src/main.py,src/utils.py" --exclude "tests/,*.md"