CLI Reference¶

Synopsis¶

occ [directories...] [options]

If no directories are specified, OCC scans the current working directory.

Flags¶

Flag Details¶

--by-file / -f¶

Show one row per file instead of grouping by document type:

occ --by-file docs/

--format <type>¶

Choose between tabular (default terminal tables) or json (machine-readable):

occ --format json docs/

--include-ext <exts>¶

Only scan specific file extensions:

occ --include-ext pdf,docx docs/

--exclude-ext <exts>¶

Skip specific file extensions:

occ --exclude-ext xlsx,pptx docs/

--exclude-dir <dirs>¶

Skip entire directories (comma-separated):

occ --exclude-dir node_modules,.git,vendor,build docs/

--no-gitignore¶

By default, OCC respects .gitignore rules. Use this flag to scan all files regardless:

occ --no-gitignore docs/

--sort <col>¶

Sort output rows by a column. Available values: files, name, words, size:

occ --sort words docs/

--output <file> / -o¶

Write output to a file instead of stdout:

occ --output report.txt docs/
occ --format json -o report.json docs/

--ci¶

ASCII-only output with no ANSI color codes, suitable for CI pipelines:

occ --ci docs/

--large-file-limit <mb>¶

Skip files exceeding the specified size in megabytes:

occ --large-file-limit 100 docs/

--structure¶

Extract and display document heading hierarchy. Works with DOCX, PDF, PPTX, ODT, and ODP. Spreadsheets (XLSX, ODS) are skipped since they have no heading hierarchy.

# Tree view of headings per document
occ --structure docs/

# Structure as JSON (includes nodes with character offsets and page mappings)
occ --structure --format json docs/

# Combine with other flags
occ --structure --by-file --no-code docs/

The structure output runs alongside existing metrics — the metrics pipeline is untouched.

--no-code¶

Skip the scc code analysis section entirely:

occ --no-code docs/

Exit Codes¶

Environment Variables¶