Compare commits
6 commits
6a72faf83b
...
627a4d7995
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
627a4d7995 | ||
|
|
f1b6d33f0a | ||
|
|
bec5305301 | ||
|
|
a07e4e5ca5 | ||
|
|
0cc0320ac1 | ||
|
|
68171c4797 |
7 changed files with 21 additions and 8 deletions
1
.doc-review-cursor
Normal file
1
.doc-review-cursor
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
6a72faf83b3aeb35ee44da51898fe8cbce6f5002
|
||||||
12
AGENTS.md
12
AGENTS.md
|
|
@ -24,12 +24,22 @@ Before making changes, read in this order:
|
||||||
|
|
||||||
- `server/`: Express REST API and orchestration services
|
- `server/`: Express REST API and orchestration services
|
||||||
- `ui/`: React + Vite board UI
|
- `ui/`: React + Vite board UI
|
||||||
|
- `cli/`: CLI package (`paperclipai` command)
|
||||||
- `packages/db/`: Drizzle schema, migrations, DB clients
|
- `packages/db/`: Drizzle schema, migrations, DB clients
|
||||||
- `packages/shared/`: shared types, constants, validators, API path constants
|
- `packages/shared/`: shared types, constants, validators, API path constants
|
||||||
- `packages/adapters/`: agent adapter implementations (Claude, Codex, Cursor, etc.)
|
- `packages/adapters/`: agent adapter implementations (Claude, Codex, Cursor, etc.)
|
||||||
- `packages/adapter-utils/`: shared adapter utilities
|
- `packages/adapter-utils/`: shared adapter utilities
|
||||||
- `packages/plugins/`: plugin system packages
|
- `packages/plugins/`: plugin system packages
|
||||||
|
- `skills/`: agent skills (Paperclip skill, company skills)
|
||||||
- `doc/`: operational and product docs
|
- `doc/`: operational and product docs
|
||||||
|
- `docs/`: Mintlify documentation site
|
||||||
|
- `tests/`: end-to-end and release smoke tests
|
||||||
|
- `scripts/`: build, dev, and release scripts
|
||||||
|
- `evals/`: promptfoo evaluation suites
|
||||||
|
- `releases/`: release notes
|
||||||
|
- `patches/`: pnpm dependency patches
|
||||||
|
- `docker/`: Docker configuration
|
||||||
|
- `report/`: generated analysis and audit reports
|
||||||
|
|
||||||
## 4. Dev Setup (Auto DB)
|
## 4. Dev Setup (Auto DB)
|
||||||
|
|
||||||
|
|
@ -55,7 +65,7 @@ curl http://localhost:3100/api/companies
|
||||||
Reset local dev DB:
|
Reset local dev DB:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
rm -rf data/pglite
|
rm -rf ~/.paperclip/instances/default/db
|
||||||
pnpm dev
|
pnpm dev
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -11,8 +11,8 @@ We really appreciate both small fixes and thoughtful larger changes.
|
||||||
- Pick **one** clear thing to fix/improve
|
- Pick **one** clear thing to fix/improve
|
||||||
- Touch the **smallest possible number of files**
|
- Touch the **smallest possible number of files**
|
||||||
- Make sure the change is very targeted and easy to review
|
- Make sure the change is very targeted and easy to review
|
||||||
- All automated checks pass (including Greptile comments)
|
- All automated checks pass (CI typecheck, tests, build)
|
||||||
- No new lint/test failures
|
- No new test failures
|
||||||
|
|
||||||
These almost always get merged quickly when they're clean.
|
These almost always get merged quickly when they're clean.
|
||||||
|
|
||||||
|
|
@ -27,7 +27,7 @@ These almost always get merged quickly when they're clean.
|
||||||
- Clear description of what & why
|
- Clear description of what & why
|
||||||
- Proof it works (manual testing notes)
|
- Proof it works (manual testing notes)
|
||||||
- All tests passing
|
- All tests passing
|
||||||
- All Greptile + other PR comments addressed
|
- All PR review comments addressed
|
||||||
|
|
||||||
PRs that follow this path are **much** more likely to be accepted, even when they're large.
|
PRs that follow this path are **much** more likely to be accepted, even when they're large.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -244,7 +244,7 @@ See [doc/DEVELOPING.md](doc/DEVELOPING.md) for the full development guide.
|
||||||
- ⚪ Artifacts & Deployments
|
- ⚪ Artifacts & Deployments
|
||||||
- ⚪ CEO Chat
|
- ⚪ CEO Chat
|
||||||
- ⚪ MAXIMIZER MODE
|
- ⚪ MAXIMIZER MODE
|
||||||
- ⚪ Multiple Human Users
|
- ✅ Multiple Human Users
|
||||||
- ⚪ Cloud / Sandbox agents (e.g. Cursor / e2b agents)
|
- ⚪ Cloud / Sandbox agents (e.g. Cursor / e2b agents)
|
||||||
- ⚪ Cloud deployments
|
- ⚪ Cloud deployments
|
||||||
- ⚪ Desktop App
|
- ⚪ Desktop App
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,7 @@ I am researching the Facebook ads Granola uses (current task)
|
||||||
|
|
||||||
Tasks have parentage. Every task exists in service of a parent task, all the way up to the company goal. This is what keeps autonomous agents aligned — they can always answer "why am I doing this?"
|
Tasks have parentage. Every task exists in service of a parent task, all the way up to the company goal. This is what keeps autonomous agents aligned — they can always answer "why am I doing this?"
|
||||||
|
|
||||||
More detailed task structure TBD.
|
Tasks carry statuses (backlog, todo, in_progress, in_review, done, blocked, cancelled), priorities, project and goal associations, billing codes for cross-team cost attribution, and execution workspace context. See [SPEC.md](./SPEC.md) for the full task model.
|
||||||
|
|
||||||
## Principles
|
## Principles
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -196,6 +196,7 @@ Agent configuration includes an **adapter** that defines how Paperclip invokes t
|
||||||
| `codex_local` | Local Codex process | Codex CLI heartbeat worker |
|
| `codex_local` | Local Codex process | Codex CLI heartbeat worker |
|
||||||
| `opencode_local` | Local OpenCode process | OpenCode heartbeat worker |
|
| `opencode_local` | Local OpenCode process | OpenCode heartbeat worker |
|
||||||
| `pi_local` | Local Pi process | Pi CLI heartbeat worker |
|
| `pi_local` | Local Pi process | Pi CLI heartbeat worker |
|
||||||
|
| `gemini_local` | Local Gemini process | Gemini CLI heartbeat worker |
|
||||||
| `cursor` | Cursor API/CLI bridge | Cursor-integrated heartbeat worker |
|
| `cursor` | Cursor API/CLI bridge | Cursor-integrated heartbeat worker |
|
||||||
| `openclaw_gateway` | OpenClaw gateway API | Managed OpenClaw agent via gateway |
|
| `openclaw_gateway` | OpenClaw gateway API | Managed OpenClaw agent via gateway |
|
||||||
| `hermes_local` | Local Hermes process | Hermes agent heartbeat worker |
|
| `hermes_local` | Local Hermes process | Hermes agent heartbeat worker |
|
||||||
|
|
@ -434,7 +435,7 @@ The core Paperclip system must be extensible. Features like knowledge bases, ext
|
||||||
- Well-defined API boundaries that plugins can hook into
|
- Well-defined API boundaries that plugins can hook into
|
||||||
- Event system or hooks for reacting to task/Agent lifecycle events
|
- Event system or hooks for reacting to task/Agent lifecycle events
|
||||||
- **Agent Adapter plugins** — new Adapter types can be registered via the plugin system
|
- **Agent Adapter plugins** — new Adapter types can be registered via the plugin system
|
||||||
- Plugin-registrable UI components (future)
|
- Plugin-registrable UI components (toolbar buttons, pages, slots)
|
||||||
|
|
||||||
The plugin framework has shipped. Plugins can register new adapter types, hook into lifecycle events, and contribute UI components (e.g. global toolbar buttons). A plugin SDK and CLI commands (`paperclipai plugin`) are available for authoring and installing plugins.
|
The plugin framework has shipped. Plugins can register new adapter types, hook into lifecycle events, and contribute UI components (e.g. global toolbar buttons). A plugin SDK and CLI commands (`paperclipai plugin`) are available for authoring and installing plugins.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -37,6 +37,7 @@ Built-in adapters:
|
||||||
- `claude_local`: runs your local `claude` CLI
|
- `claude_local`: runs your local `claude` CLI
|
||||||
- `codex_local`: runs your local `codex` CLI
|
- `codex_local`: runs your local `codex` CLI
|
||||||
- `opencode_local`: runs your local `opencode` CLI
|
- `opencode_local`: runs your local `opencode` CLI
|
||||||
|
- `gemini_local`: runs your local Gemini CLI
|
||||||
- `hermes_local`: runs your local `hermes` CLI
|
- `hermes_local`: runs your local `hermes` CLI
|
||||||
- `cursor`: runs Cursor in background mode
|
- `cursor`: runs Cursor in background mode
|
||||||
- `pi_local`: runs an embedded Pi agent locally
|
- `pi_local`: runs an embedded Pi agent locally
|
||||||
|
|
@ -44,7 +45,7 @@ Built-in adapters:
|
||||||
- `process`: generic shell command adapter
|
- `process`: generic shell command adapter
|
||||||
- `http`: calls an external HTTP endpoint
|
- `http`: calls an external HTTP endpoint
|
||||||
|
|
||||||
For local CLI adapters (`claude_local`, `codex_local`, `opencode_local`, `hermes_local`), Paperclip assumes the CLI is already installed and authenticated on the host machine.
|
For local CLI adapters (`claude_local`, `codex_local`, `opencode_local`, `gemini_local`, `hermes_local`), Paperclip assumes the CLI is already installed and authenticated on the host machine.
|
||||||
|
|
||||||
## 3.2 Runtime behavior
|
## 3.2 Runtime behavior
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue