mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-15 09:01:14 +00:00
3559a43ba0
- Move RPC files to modes/rpc/ directory - Add properly typed RpcCommand and RpcResponse types - Expose full AgentSession API via RPC commands: - State: get_state - Model: set_model, cycle_model, get_available_models - Thinking: set_thinking_level, cycle_thinking_level - Queue: set_queue_mode - Compaction: compact, set_auto_compaction - Bash: bash, abort_bash - Session: get_session_stats, export_html, switch_session, branch, etc. - Add RpcClient class for programmatic access - Rewrite tests to use RpcClient instead of raw process spawning - All commands support optional correlation ID for request/response matching
131 lines
5.4 KiB
Markdown
131 lines
5.4 KiB
Markdown
# Development Rules
|
|
|
|
## First Message
|
|
If the user did not give you a concrete task in their first message,
|
|
read README.md, then ask which module(s) to work on. Based on the answer, read the relevant README.md files in parallel.
|
|
- packages/ai/README.md
|
|
- packages/tui/README.md
|
|
- packages/agent/README.md
|
|
- packages/coding-agent/README.md
|
|
- packages/mom/README.md
|
|
- packages/pods/README.md
|
|
- packages/web-ui/README.md
|
|
|
|
## Code Quality
|
|
- No `any` types unless absolutely necessary
|
|
- Check node_modules for external API type definitions instead of guessing
|
|
- No inline imports like `await import("./foo.js")`
|
|
|
|
## Commands
|
|
- After code changes: `npm run check` (get full output, no tail)
|
|
- NEVER run: `npm run dev`, `npm run build`
|
|
- NEVER commit unless user asks
|
|
|
|
## GitHub Issues
|
|
When reading issues:
|
|
- Always read all comments on the issue
|
|
|
|
When creating issues:
|
|
- Add `pkg:*` labels to indicate which package(s) the issue affects
|
|
- Available labels: `pkg:agent`, `pkg:ai`, `pkg:coding-agent`, `pkg:mom`, `pkg:pods`, `pkg:proxy`, `pkg:tui`, `pkg:web-ui`
|
|
- If an issue spans multiple packages, add all relevant labels
|
|
|
|
When closing issues via commit:
|
|
- Include `fixes #<number>` or `closes #<number>` in the commit message
|
|
- This automatically closes the issue when the commit is merged
|
|
|
|
## Tools
|
|
- GitHub CLI for issues/PRs
|
|
- Add package labels to issues/PRs: pkg:agent, pkg:ai, pkg:coding-agent, pkg:mom, pkg:pods, pkg:proxy, pkg:tui, pkg:web-ui
|
|
- Browser tools (~/agent-tools/browser-tools/README.md): browser automation for frontend testing, web searches, fetching documentation
|
|
- TUI interaction: use tmux
|
|
|
|
## Style
|
|
- Keep answers short and concise
|
|
- No emojis in commits, issues, PR comments, or code
|
|
- No fluff or cheerful filler text
|
|
- Technical prose only, be kind but direct (e.g., "Thanks @user" not "Thanks so much @user!")
|
|
|
|
## Changelog
|
|
- New entries ALWAYS go under `## [Unreleased]` section
|
|
- NEVER modify already-released version sections (e.g., `## [0.12.2]`)
|
|
- Each version section is immutable once released
|
|
- When releasing: rename `[Unreleased]` to the new version, then add a fresh empty `[Unreleased]` section
|
|
|
|
## Releasing
|
|
|
|
1. **Bump version** (all packages use lockstep versioning):
|
|
```bash
|
|
npm run version:patch # For bug fixes
|
|
npm run version:minor # For new features
|
|
npm run version:major # For breaking changes
|
|
```
|
|
|
|
2. **Finalize CHANGELOG.md**: Change `[Unreleased]` to the new version with today's date (e.g., `## [0.12.12] - 2025-12-05`)
|
|
|
|
3. **Commit and tag**:
|
|
```bash
|
|
git add .
|
|
git commit -m "Release v0.12.12"
|
|
git tag v0.12.12
|
|
git push origin main
|
|
git push origin v0.12.12
|
|
```
|
|
|
|
4. **Publish to npm**:
|
|
```bash
|
|
npm run publish
|
|
```
|
|
|
|
5. **Add new [Unreleased] section** at top of CHANGELOG.md for next cycle, commit it
|
|
|
|
## coding-agent Code Map
|
|
|
|
```
|
|
packages/coding-agent/src/
|
|
├── cli.ts # CLI entry point
|
|
├── main.ts # Main orchestration, mode routing
|
|
├── index.ts # Public exports
|
|
|
|
├── cli/ # CLI-specific utilities
|
|
│ ├── args.ts # Argument parsing, help display
|
|
│ ├── file-processor.ts # @file argument processing
|
|
│ └── session-picker.ts # TUI session selector for --resume
|
|
|
|
├── core/ # Core business logic (mode-agnostic)
|
|
│ ├── agent-session.ts # AgentSession: unified session management
|
|
│ ├── bash-executor.ts # Bash command execution
|
|
│ ├── compaction.ts # Context compaction logic
|
|
│ ├── export-html.ts # HTML export functionality
|
|
│ ├── messages.ts # Message types and transformers
|
|
│ ├── model-config.ts # Model configuration loading
|
|
│ ├── model-resolver.ts # Model resolution and scoping
|
|
│ ├── session-manager.ts # Session persistence (JSONL)
|
|
│ ├── settings-manager.ts # User settings persistence
|
|
│ ├── slash-commands.ts # Slash command loading
|
|
│ ├── system-prompt.ts # System prompt construction
|
|
│ ├── oauth/ # OAuth authentication
|
|
│ └── tools/ # Tool implementations (read, bash, edit, write, etc.)
|
|
|
|
├── modes/ # Run mode implementations
|
|
│ ├── index.ts # Mode exports
|
|
│ ├── print-mode.ts # Non-interactive print mode
|
|
│ ├── rpc-mode.ts # RPC/JSON mode for programmatic use
|
|
│ └── interactive/ # Interactive TUI mode
|
|
│ ├── interactive-mode.ts # InteractiveMode class
|
|
│ ├── components/ # TUI components
|
|
│ └── theme/ # Theme definitions
|
|
|
|
└── utils/ # Generic utilities
|
|
├── changelog.ts # Changelog parsing
|
|
├── clipboard.ts # Clipboard operations
|
|
├── config.ts # App configuration, paths
|
|
├── fuzzy.ts # Fuzzy matching
|
|
├── shell.ts # Shell detection
|
|
└── tools-manager.ts # External tool management (fd, etc.)
|
|
```
|
|
|
|
Key abstractions:
|
|
- `AgentSession` (core/agent-session.ts): Central session management, wraps Agent with persistence, compaction, model cycling
|
|
- `InteractiveMode` (modes/interactive/interactive-mode.ts): TUI rendering and user interaction
|
|
- `runPrintMode` / `runRpcMode`: Non-interactive output modes
|