Skip to main content

Configuration

argus works out of the box without configuration, but you can customize its behavior.

Configuration File

Create a .argus.yaml or .argus.json in your project root:

# .argus.yaml
output: CLAUDE.md
verbose: false

# Directories to exclude from scanning
exclude:
- node_modules
- .git
- dist
- build
- vendor

# Custom sections to preserve
preserve_custom: true

Configuration Options

OptionTypeDefaultDescription
outputstringCLAUDE.mdOutput file path
verbosebooleanfalseEnable verbose logging
excludestring[](built-in list)Directories to exclude
preserve_custombooleantrueKeep custom section on re-scan

Default Exclusions

argus automatically excludes common non-source directories:

  • node_modules/
  • .git/
  • vendor/
  • dist/, build/, out/
  • __pycache__/, .venv/, venv/
  • .idea/, .vscode/
  • coverage/

Environment Variables

VariableDescription
ARGUS_VERBOSEEnable verbose mode
ARGUS_CONFIGPath to config file

Gitignore Integration

argus respects your .gitignore file. Any patterns in .gitignore are automatically excluded from scanning.

Example Configurations

Monorepo

output: docs/AI_CONTEXT.md
exclude:
- node_modules
- .turbo
- apps/*/dist
- packages/*/dist

Go Project

output: CLAUDE.md
exclude:
- vendor
- bin
- testdata

Python Project

output: AI_CONTEXT.md
exclude:
- .venv
- __pycache__
- .pytest_cache
- dist
- "*.egg-info"