Skip to main content

Scan Command

The scan command analyzes your codebase and writes AGENTS.md plus a CLAUDE.md that imports it.

Basic Usage​

# Scan current directory
argus scan .

# Scan a specific path
argus scan /path/to/project

Options​

FlagShortDescription
--format-fOutput format: agents, claude (writes AGENTS.md too), claude-code, cursor, copilot, all
--fullWrite the detailed sections (structure, key files, patterns, dependencies)
--verbose-vShow detailed analysis output
--dry-run-nPreview output without writing files
--merge-mKeep your text around the generated block when regenerating (default true; --merge=false replaces the whole file)
--add-customAdd an empty CUSTOM block for your notes to the Markdown outputs
--forceOverwrite files argus would otherwise skip: edited .claude/ and .continue/config.yaml files, an AGENTS.md without markers, and files with unbalanced or repeated ARGUS:AUTO markers

--compact (lean output is now the default) and -o/--output (no effect) are deprecated.

See Output Format for what a re-scan keeps and what it skips.

Examples​

Preview Output​

argus scan . --dry-run

This shows what would be written without creating any files.

Verbose Mode​

argus scan . -v

Shows detailed progress:

  • Files being scanned
  • Patterns detected
  • Time taken for each phase

Scan Specific Directory​

argus scan ./backend

What Gets Analyzed​

argus performs a comprehensive analysis:

  1. File Discovery - Walks the directory tree, respecting .gitignore
  2. Tech Stack Detection - Identifies languages, frameworks, libraries
  3. Architecture Analysis - Understands project structure and patterns
  4. Command Discovery - Finds build, test, lint, and run commands
  5. Convention Detection - Discovers coding standards and practices
  6. Git Analysis - Examines commit patterns and branch conventions

Output Structure​

The default AGENTS.md is lean, at most 150 lines:

├── Project name and description
├── Commands (setup, build, test, lint, ...)
├── Stack
├── Conventions
├── Git
└── API (when endpoints are found)

With --full it includes:

├── Project Overview
├── Quick Reference (commands)
├── Architecture
│ ├── Style (monolith, microservices, etc.)
│ ├── Entry Point
│ └── Package Dependencies
├── Tech Stack
│ ├── Languages
│ ├── Frameworks
│ └── Tools
├── Project Structure
├── Key Files
├── Configuration
├── Development Setup
├── Coding Conventions
├── Detected Patterns
└── Dependencies

Performance​

argus uses parallel analysis for better performance:

  • Phase 1: Essential detectors (tech stack, structure)
  • Phase 2: All other detectors run concurrently
  • Typical scan time: 1-5 seconds for most projects