The all-seeing code analyzer. Help AI grok your codebase.
Argus scans your codebase and generates optimized context files for AI coding assistants — no more manually writing AGENTS.md or CLAUDE.md.
If you find this useful, consider giving it a ⭐ star on GitHub — it helps others discover the project!
You: *opens Cursor/Claude Code*
AI: "I don't know your project structure, conventions, or patterns"
You: *spends 30 mins writing CLAUDE.md*
You: *file gets stale in 2 weeks*
You: *repeat*
argus scan
# Argus analyzes your codebase and generates:
# ✓ AGENTS.md (for Codex, Cursor, Copilot, Gemini CLI and other agents)
# ✓ CLAUDE.md (for Claude Code, imports AGENTS.md)
# and with --format: .claude/, .cursor/rules/argus.mdc, .github/copilot-instructions.mdcurl -fsSL https://raw.githubusercontent.com/Priyans-hu/argus/main/install.sh | bashgo install github.com/Priyans-hu/argus/cmd/argus@latestbrew install Priyans-hu/tap/argusDownload from Releases.
Let your coding agent run argus for you (Claude Code, Codex, Cursor, Copilot, Gemini CLI and more):
npx skills add Priyans-hu/argus --skill argus # add -g for all projectsIn Claude Code you can also run /plugin install argus --marketplace Priyans-hu/argus (older versions: /plugin marketplace add Priyans-hu/argus, then /plugin install argus@argus). The skill drives the CLI, so install argus as well.
# Navigate to your project
cd your-project
# Scan and generate context files
argus scan
# Keep files synced with changes
argus syncRun argus scan or argus sync as often as you like:
AGENTS.md,CLAUDE.md,.cursor/rules/argus.mdcand.github/copilot-instructions.mdhold the generated content between<!-- ARGUS:AUTO -->markers. A rescan replaces only that block; anything you write above or below it is kept.- A file without markers (hand-written, or from an older argus) keeps its text below a new generated block, and argus tells you once. The exception is an
AGENTS.mdwithout markers: argus leaves it unchanged and warns; add an emptyARGUS:AUTOpair to opt in, or use--force. .claude/**and.continue/config.yamlare written once. If you edit them, later runs leave them alone and report them;--forceoverwrites them.- A file whose content would not change is not rewritten.
- Tech Stack — Frameworks, languages, databases
- Project Structure — Directory layout, key files
- Conventions — Naming patterns, code style, formatting
- Dependencies — Package managers, libraries
- Commands — Build, test, dev scripts
- Patterns — API shapes, error handling, state management
# your-project
A Next.js app for booking meeting rooms.
## Commands
```bash
# Setup
npm install
npm ci
# Build
npm run build
# Test
npm test
npx vitest run <file>
# Lint
npm run lint
# Run
npm run dev
npm start
```
## Stack
- Languages: TypeScript 100%
- Frameworks: Prisma, Next.js, React, TypeScript, Vitest, ESLint
## Conventions
- Path aliases configured: @
- Absolute imports enabled with baseUrl: .
- TypeScript strict mode enabled - maintain strict type safety
## Git
- Repository: acme/your-project
- Commit style: Conventional Commits
- Commit format: `<type>(<scope>): <description>`argus scan --full adds the project structure, key files, detected patterns and dependencies.
| Format | File | AI Tool |
|---|---|---|
| Agents | AGENTS.md |
Codex, Cursor, Copilot, Gemini CLI and other agents |
| Claude | CLAUDE.md (imports AGENTS.md) |
Claude Code |
| Claude Code | .claude/ (agents, rules, skills, hooks) |
Claude Code |
| Cursor | .cursor/rules/argus.mdc |
Cursor |
| Copilot | .github/copilot-instructions.md |
GitHub Copilot |
| Continue (deprecated) | .continue/config.yaml |
Continue.dev |
argus scan writes AGENTS.md and CLAUDE.md. Choose formats with --format or output: in .argus.yaml; --format all writes every format except Continue. Claude Code only creates missing files, its formatter hooks need jq, and argus writes no MCP config.
argus init # Initialize config (optional)
argus scan # Analyze and generate files
argus sync # Update files with changes
argus scan --full # Detailed AGENTS.md (structure, key files, patterns)
argus scan --force # Also overwrite files argus would skip (edited .claude/ files, an AGENTS.md without markers)
argus --version # Print version (same as argus version)--compact (lean output is now the default) and -o/--output (no effect) are deprecated.
argus check exits 1 when a generated file is out of date, for CI. It needs full git history (fetch-depth: 0), takes the title from the checkout directory name, so a clone under another name shows drift, and cannot check --ai or --full output.
Create .argus.yaml to customize:
output:
- agents
- claude
- cursor
ignore:
- node_modules
- .git
- dist
custom_conventions:
- "Use React Query for data fetching"
- "All API routes return { success, data, error }"In Greek mythology, Argus Panoptes was a giant with 100 eyes — the "all-seeing."
Argus sees your entire codebase so AI doesn't have to guess.
See CONTRIBUTING.md.
MIT — see LICENSE.