Skip to content

Commit fe00145

Browse files
committed
feat: update AGENTS.md
1 parent d2770aa commit fe00145

2 files changed

Lines changed: 14 additions & 44 deletions

File tree

.deepcode/AGENTS.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ src/
2222
│ ├── process-tree.ts # Process tree construction and orphan detection
2323
│ ├── shell-utils.ts # Shell path resolution (Git Bash, zsh, bash)
2424
│ ├── state.ts # In-memory file state and snippet tracking
25+
│ ├── telemetry.ts # Usage telemetry collection and reporting
2526
│ ├── update-check.ts # Latest-version check against npm registry
2627
│ └── validate.ts # Tool validation runtime helpers (was runtime.ts)
2728
├── mcp/
@@ -37,20 +38,23 @@ src/
3738
│ ├── web-search-handler.ts # Web search via natural language queries
3839
│ └── ask-user-question-handler.ts # Interactive user prompts with options
3940
├── ui/
40-
│ ├── components/ # Reusable Ink components (MessageView, DropdownMenu, ModelsDropdown, SkillsDropdown, etc.)
41+
│ ├── components/ # Reusable Ink components (MessageView, DropdownMenu, ModelsDropdown, SkillsDropdown, FileMentionMenu, RawModelDropdown, etc.)
4142
│ ├── contexts/ # React contexts (AppContext, RawModeContext)
4243
│ ├── hooks/ # Custom hooks (cursor, useHistoryNavigation, usePasteHandling, useTerminalInput)
43-
│ ├── views/ # Top-level screen components (App, PromptInput, SessionList, PermissionPrompt, ProcessStdoutView, etc.)
44-
│ ├── core/ # Core UI logic (file-mentions, slash-commands, prompt-buffer, thinking-state, etc.)
44+
│ ├── views/ # Top-level screen components (App, PromptInput, SessionList, PermissionPrompt, ProcessStdoutView, WelcomeScreen, UndoSelector, etc.)
45+
│ ├── core/ # Core UI logic (file-mentions, slash-commands, prompt-buffer, thinking-state, clipboard, prompt-undo-redo, etc.)
4546
│ ├── utils/ # Shared utility helpers
47+
│ ├── ascii-art.ts # ASCII art banner for welcome screen
48+
│ ├── exit-summary.ts # Session exit summary and cost reporting
4649
│ ├── index.ts # UI module barrel exports
4750
│ └── constants.ts # UI-wide constants
48-
├── tests/ # One *.test.ts per source module, plus run-tests.mjs
51+
├── tests/ # Test files per source module, plus run-tests.mjs
4952
templates/
5053
├── tools/ # Tool descriptions fed to the LLM
51-
├── skills/ # Built-in skill definitions (agent-drift-guard, plan-and-execute)
54+
├── skills/ # Built-in skill definitions (agent-drift-guard, plan-and-execute, karpathy-guidelines)
5255
└── prompts/ # EJS templates (e.g., init_command.md.ejs)
5356
docs/ # User-facing documentation (configuration, MCP, notify, permissions)
57+
resources/ # Static assets (intro screenshots)
5458
dist/ # Bundled CLI output (gitignored)
5559
```
5660

@@ -66,8 +70,8 @@ dist/ # Bundled CLI output (gitignored)
6670
| `npm run check` | Runs typecheck + lint + format:check together |
6771
| `npm run bundle` | esbuild bundles `src/cli.tsx``dist/cli.js` (ESM, Node 18) |
6872
| `npm run build` | `check` + `bundle` + chmod 755 — full CI gate before publish |
69-
| `npm test` | Runs all tests via `tsx --test src/tests/*.test.ts` |
70-
| `npm run test:single -- <file>` | Run a single test file (e.g., `npm run test:single -- src/tests/session.test.ts`) |
73+
| `npm test` | Runs all tests via `node src/tests/run-tests.mjs` |
74+
| `npm run test:single -- <file>` | Run a single test file via `tsx --test` (e.g., `npm run test:single -- src/tests/session.test.ts`) |
7175

7276
Run the CLI locally for manual testing: `node dist/cli.js` (after `npm run bundle`).
7377

@@ -90,7 +94,7 @@ Run the CLI locally for manual testing: `node dist/cli.js` (after `npm run bundl
9094

9195
- **Framework**: Node.js native test runner (`node:test`) with `tsx` for TypeScript
9296
- **Assertions**: `node:assert/strict`
93-
- **Coverage**: Target meaningful unit tests for core logic (session management, tool handlers, settings resolution, prompt buffer, permissions, MCP client). Test files are in `src/tests/` matching the source module name.
97+
- **Coverage**: Target meaningful unit tests for core logic (session management, tool handlers, settings resolution, prompt buffer, permissions, MCP client, telemetry). Test files are in `src/tests/` matching the source module name.
9498
- **Test naming**: `describe`/`test` blocks with descriptive names. Example: `test("SessionManager preserves structured system content when building OpenAI messages", ...)`
9599
- **Relaxed lint rules**: Test files allow `any` and unused vars.
96100
- Run all tests with `npm test` before submitting a PR. A cross-platform test runner is available at `src/tests/run-tests.mjs`.
@@ -104,6 +108,7 @@ Run the CLI locally for manual testing: `node dist/cli.js` (after `npm run bundl
104108
- `chore:` — tooling, deps, hooks (e.g., `chore: add husky + lint-staged`)
105109
- `refactor:` — code restructuring (e.g., `refactor(ui): optimize App hooks`)
106110
- `style:` — formatting-only changes (e.g., `style: adjust the tree structure symbols`)
111+
- `test:` — adding or updating tests (e.g., `test: add telemetry module unit tests`)
107112
- `docs:` — documentation (e.g., `docs: add MCP configuration guide`)
108113

109114
**Pull requests** should include:
@@ -133,4 +138,4 @@ A **file history system** (`src/common/file-history.ts`) provides undo/checkpoin
133138

134139
- **AGENTS.md loading**: The CLI loads agent instructions from `./AGENTS.md`, `./.deepcode/AGENTS.md`, or `~/.deepcode/AGENTS.md` (first found wins). Write project-specific guidance for the LLM in any of these.
135140
- **Skills**: Place skill definitions in `~/.agents/skills/<name>/SKILL.md` (user-level) or `./.agents/skills/<name>/SKILL.md` (project-level). Legacy path `./.deepcode/skills/` is also supported. Each SKILL.md uses YAML frontmatter with `name` and `description` fields.
136-
- **Built-in skills**: `agent-drift-guard` (detects and corrects execution drift) and `plan-and-execute` (structured task planning with progress tracking). Both are defined in `templates/skills/` and always injected into every session.
141+
- **Built-in skills**: `agent-drift-guard` (detects and corrects execution drift), `plan-and-execute` (structured task planning with progress tracking), and `karpathy-guidelines` (behavioral guidelines to reduce common LLM coding mistakes). All three are defined in `templates/skills/` and always injected into every session.

AGENTS.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

0 commit comments

Comments
 (0)