mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-08 00:54:38 +02:00
Nicky LeachandPaperclip
38d8f37172
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Paperclip runs across the CLI, server, adapters, plugins, CI, and container images. > - These surfaces declared different Node.js versions from 20 through 24. > - A newer `@types/node` major can expose APIs that the supported runtime does not provide. > - Node.js 20 is no longer a suitable project baseline, and Node.js 24 is the current LTS line. > - This pull request sets Node.js 24.11.0 as one repository-wide baseline, adds a drift check, and gives users actionable startup guidance when their runtime is too old. > - The benefit is one clear runtime contract for development, release, installation, and published packages. ## Linked Issues or Issue Description Refs #2734 Refs #11727 Refs #739 ## What Changed - Require Node.js 24.11.0 or newer in all 42 package manifests and runtime checks. - Use Node.js 24 in GitHub Actions, Docker images, smoke images, sandbox setup, portable installs, and esbuild targets. - Align every direct `@types/node` declaration on `^24.0.0`. - Prevent Dependabot from opening major `@types/node` upgrades without a matching runtime decision. - Add `.nvmrc` and a CI policy check for Node version drift. - Update ACP version gates, tests, and user documentation for the new minimum. - Print a non-blocking warning on CLI and server startup when Node is unsupported, with remediation through a version manager or the documented downloaded `install.sh` workflow. - Deduplicate that warning when `paperclipai run` boots the CLI and server in the same process. ## Verification - `node scripts/check-node-version-policy.mjs` - `node --check scripts/check-node-version-policy.mjs` - `node --check cli/esbuild.config.mjs` - `node --check scripts/generate-npm-package-json.mjs` - `bash -n scripts/install.sh scripts/test-install-sh-docker.sh scripts/e2e-install-lifecycle.sh` - Parsed all 42 package manifests and confirmed `engines.node` is `>=24.11.0`. - `git diff --check` - `vitest run packages/adapter-utils/src/sandbox-install-command.test.ts` passed with 3 tests. - `vitest run cli/src/node-version.test.ts` passed with 4 tests. - Directly exercised the shared warning helper for unsupported-version messaging and same-process deduplication. - The focused exe.dev suite could not resolve the locally unbuilt plugin SDK from this isolated worktree. A full offline workspace install was also blocked because the package-manager signature verifier requires registry access. The full suite was not run locally; draft CI performs a clean install and evaluates the wider impact. ## Risks - This is a breaking runtime change for users, plugins, and deployments that still use Node.js 20 or 22. - Published workspace packages will now produce an engine warning or failure in strict package managers on older Node.js releases. - Node.js 24 can reveal dependency, native module, Playwright, or agent CLI compatibility issues in CI. - The bootstrap installer now installs Node.js 24 when the current runtime is older than 24.11.0. - The portable sandbox fallback is pinned to Node.js 24.11.0 and depends on that upstream tarball remaining available. - Unsupported runtimes continue booting after a warning, so a later incompatibility can still fail at its point of use. - The CLI and server share the warning policy through the published `@paperclipai/shared` package; packaging checks must keep that subpath export available. - This PR does not commit `pnpm-lock.yaml` because repository policy assigns lockfile generation to CI. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex based on GPT-5. The exact deployment ID and context window are not exposed in this session. Reasoning, repository tools, shell execution, and GitHub tools were enabled. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
99 lines
4.5 KiB
Markdown
99 lines
4.5 KiB
Markdown
---
|
|
title: Architecture
|
|
summary: Stack overview, request flow, and adapter model
|
|
---
|
|
|
|
Paperclip is a monorepo with four main layers.
|
|
|
|
## Stack Overview
|
|
|
|
```
|
|
┌─────────────────────────────────────┐
|
|
│ React UI (Vite) │
|
|
│ Dashboard, org management, tasks │
|
|
├─────────────────────────────────────┤
|
|
│ Express.js REST API (Node.js) │
|
|
│ Routes, services, auth, adapters │
|
|
├─────────────────────────────────────┤
|
|
│ PostgreSQL (Drizzle ORM) │
|
|
│ Schema, migrations, embedded mode │
|
|
├─────────────────────────────────────┤
|
|
│ Adapters │
|
|
│ Claude Code, Codex, │
|
|
│ Process, HTTP │
|
|
└─────────────────────────────────────┘
|
|
```
|
|
|
|
## Technology Stack
|
|
|
|
| Layer | Technology |
|
|
|-------|-----------|
|
|
| Frontend | React 19, Vite 6, React Router 7, Radix UI, Tailwind CSS 4, TanStack Query |
|
|
| Backend | Node.js 24.11+, Express.js 5, TypeScript |
|
|
| Database | PostgreSQL 17 (or embedded PGlite), Drizzle ORM |
|
|
| Auth | Better Auth (sessions + API keys) |
|
|
| Adapters | Claude Code CLI, Codex CLI, shell process, HTTP webhook |
|
|
| Package manager | pnpm 9 with workspaces |
|
|
|
|
## Repository Structure
|
|
|
|
```
|
|
paperclip/
|
|
├── ui/ # React frontend
|
|
│ ├── src/pages/ # Route pages
|
|
│ ├── src/components/ # React components
|
|
│ ├── src/api/ # API client
|
|
│ └── src/context/ # React context providers
|
|
│
|
|
├── server/ # Express.js API
|
|
│ ├── src/routes/ # REST endpoints
|
|
│ ├── src/services/ # Business logic
|
|
│ ├── src/adapters/ # Agent execution adapters
|
|
│ └── src/middleware/ # Auth, logging
|
|
│
|
|
├── packages/
|
|
│ ├── db/ # Drizzle schema + migrations
|
|
│ ├── shared/ # API types, constants, validators
|
|
│ ├── adapter-utils/ # Adapter interfaces and helpers
|
|
│ └── adapters/
|
|
│ ├── claude-local/ # Claude Code adapter
|
|
│ └── codex-local/ # OpenAI Codex adapter
|
|
│
|
|
├── skills/ # Agent skills
|
|
│ └── paperclip/ # Core Paperclip skill (heartbeat protocol)
|
|
│
|
|
├── cli/ # CLI client
|
|
│ └── src/ # Setup and control-plane commands
|
|
│
|
|
└── doc/ # Internal documentation
|
|
```
|
|
|
|
## Request Flow
|
|
|
|
When a heartbeat fires:
|
|
|
|
1. **Trigger** — Scheduler, manual invoke, or event (assignment, mention) triggers a heartbeat
|
|
2. **Adapter invocation** — Server calls the configured adapter's `execute()` function
|
|
3. **Agent process** — Adapter spawns the agent (e.g. Claude Code CLI) with Paperclip env vars and a prompt
|
|
4. **Agent work** — The agent calls Paperclip's REST API to check assignments, checkout tasks, do work, and update status
|
|
5. **Result capture** — Adapter captures stdout, parses usage/cost data, extracts session state
|
|
6. **Run record** — Server records the run result, costs, and any session state for next heartbeat
|
|
|
|
## Adapter Model
|
|
|
|
Adapters are the bridge between Paperclip and agent runtimes. Each adapter is a package with three modules:
|
|
|
|
- **Server module** — `execute()` function that spawns/calls the agent, plus environment diagnostics
|
|
- **UI module** — stdout parser for the run viewer, config form fields for agent creation
|
|
- **CLI module** — terminal formatter for `paperclipai run --watch`
|
|
|
|
Built-in adapters: `claude_local`, `codex_local`, `process`, `http`. You can create custom adapters for any runtime.
|
|
|
|
## Key Design Decisions
|
|
|
|
- **Control plane, not execution plane** — Paperclip orchestrates agents; it doesn't run them
|
|
- **Company-scoped** — all entities belong to exactly one company; strict data boundaries
|
|
- **Single-assignee tasks** — atomic checkout prevents concurrent work on the same task
|
|
- **Adapter-agnostic** — any runtime that can call an HTTP API works as an agent
|
|
- **Embedded by default** — zero-config local mode with embedded PostgreSQL
|