Clyde Help

scan-report

Summarize repository scan shape with largest files, extensions, skip reasons, and chunk counts.

AccessRead-only
NetworkNone
SourceBuilt-in Clyde command

Syntax#

clyde scan-report REPO [scan flags] [--json] [--top N]

Options#

FlagPurpose
--jsonPrint a machine-readable repository scan report.
--topNumber of largest included files to show.
--includeOnly include matching globs; repeatable.
--excludeSkip matching globs in addition to defaults; repeatable.
--max-file-bytesSkip files larger than this many bytes.
--max-chunk-charsSplit source text at this many characters.

Arguments#

  • REPO is the repository path to scan.

Examples#

clyde scan-report .
clyde scan-report . --json
clyde scan-report . --include "internal/**/*.go" --top 20

Example Use Cases#

Use scan-report when a human, CI job, or AI assistant needs compact repository-shape context before running agent, bundle, or sync. The report includes included/skipped counts, chunk count, largest included files, extension counts, skip reasons, and scan limits.

Safety Notes#

scan-report is read-only. It does not write bundle files, upload source, or contact Ollama or NotebookLM.