forked from farhoodlabs/paperclip
Dotta
9eac727cf1
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies through company-scoped control-plane workflows. > - Agents need reusable, inspectable skills that can be installed, reset, audited, exported, and assigned without bespoke local setup. > - The existing skill truth model needed cleanup so bundled skills, optional catalog skills, runtime skills, and adapter-provided skills have clear provenance. > - Operators also need a practical CLI and board UI for discovering and managing company skills. > - This pull request adds the skills CLI, packaged skills catalog, company skills APIs, and catalog-aware board UI. > - The benefit is a more reusable Paperclip company setup where skills are portable, auditable, and easier for operators and agents to manage. ## What Changed - Added `paperclipai skills` CLI commands and coverage for catalog listing, installing, resetting, and inspecting company skills. - Added a packaged `@paperclipai/skills-catalog` workspace with bundled and optional skill content plus validation/build tests. - Added shared company-skill types and validators used across CLI, server, and UI contracts. - Added server catalog APIs/services for company skill catalog operations, reset semantics, audit behavior, and portability provenance. - Updated adapter skill handling so runtime/catalog provenance remains explicit across local adapters. - Added board UI support for browsing and managing catalog-backed company skills. - Updated docs for the skills CLI/catalog flow and the company skills Paperclip skill reference. - Rebased the branch onto current `paperclipai/paperclip:master`; no `pnpm-lock.yaml`, `.github/workflows`, or migration files are included in the final PR diff. ## Verification - Passed: `pnpm run preflight:workspace-links && pnpm exec vitest run cli/src/__tests__/skills.test.ts packages/skills-catalog/src/catalog-builder.test.ts packages/skills-catalog/src/shipped-catalog.test.ts packages/shared/src/validators/company-skill.test.ts packages/adapter-utils/src/server-utils.test.ts packages/plugins/create-paperclip-plugin/src/entrypoints.test.ts server/src/__tests__/company-skills-catalog-service.test.ts server/src/__tests__/company-skills-routes.test.ts server/src/__tests__/company-portability.test.ts`. - Passed: `pnpm exec vitest run server/src/__tests__/workspace-runtime.test.ts -t "default branch|origin/master|symbolic-ref"`. - Attempted: full `server/src/__tests__/workspace-runtime.test.ts`. Four provisioning tests failed while seeding an isolated worktree database from the local Paperclip instance because the local plugin schema dump contains a duplicate-column foreign key (`plugin_content_machine_18a7bc327b.content_case_signals`). The default-branch tests touched by the rebase conflict passed in the focused run above. - Checked final diff: no `pnpm-lock.yaml`, no `.github/workflows`, and no migration-file changes relative to `master`. ## Risks - Medium: this is a broad skills/catalog change touching CLI, server APIs, shared contracts, adapter skill sync, and UI. - Catalog validation and reset semantics need careful reviewer attention because they affect reusable company setup and portability. - No database migrations are included in this PR, so there is no migration ordering/idempotency risk in the final diff. - No lockfile is included by design; dependency resolution will be handled by the repository lockfile workflow. ## Model Used - OpenAI Codex coding agent based on GPT-5, running in Paperclip via the `codex_local` adapter with shell, git, GitHub CLI, and code-editing tool access. Exact hosted model build/context-window metadata is not exposed in this runtime. ## 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 run targeted tests locally and documented the local workspace-runtime seed failure above - [x] I have added or updated tests where applicable - [x] If this change affects the UI, screenshots were intentionally omitted per PAP-10124 instructions; UI behavior is covered by tests and reviewer inspection - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
# @paperclipai/create-paperclip-plugin
|
|
|
|
Scaffolding tool for creating new Paperclip plugins.
|
|
|
|
```bash
|
|
npx @paperclipai/create-paperclip-plugin my-plugin
|
|
```
|
|
|
|
Or with options:
|
|
|
|
```bash
|
|
npx @paperclipai/create-paperclip-plugin @acme/my-plugin \
|
|
--template connector \
|
|
--category connector \
|
|
--display-name "Acme Connector" \
|
|
--description "Syncs Acme data into Paperclip" \
|
|
--author "Acme Inc"
|
|
```
|
|
|
|
Supported templates: `default`, `connector`, `workspace`
|
|
Supported categories: `connector`, `workspace`, `automation`, `ui`
|
|
|
|
Generates:
|
|
- typed manifest + worker entrypoint
|
|
- example UI widget using the supported `@paperclipai/plugin-sdk/ui` hooks
|
|
- test file using `@paperclipai/plugin-sdk/testing`
|
|
- `esbuild` and `rollup` config files using SDK bundler presets
|
|
- dev server script for hot-reload (`paperclip-plugin-dev-server`)
|
|
|
|
The scaffold starts with plain React elements so the generated plugin stays minimal. For Paperclip-native controls, import shared host components such as `MarkdownEditor`, `FileTree`, `AssigneePicker`, and `ProjectPicker` from `@paperclipai/plugin-sdk/ui`.
|
|
|
|
Inside this repo, the generated package uses `@paperclipai/plugin-sdk` via `workspace:*`.
|
|
|
|
Outside this repo, the scaffold snapshots `@paperclipai/plugin-sdk` from your local Paperclip checkout into a `.paperclip-sdk/` tarball and points the generated package at that local file by default. You can override the SDK source explicitly:
|
|
|
|
```bash
|
|
node packages/plugins/create-paperclip-plugin/dist/bin.js @acme/my-plugin \
|
|
--output /absolute/path/to/plugins \
|
|
--sdk-path /absolute/path/to/paperclip/packages/plugins/sdk
|
|
```
|
|
|
|
That gives you an outside-repo local development path before the SDK is published to npm.
|
|
|
|
## Workflow after scaffolding
|
|
|
|
```bash
|
|
cd my-plugin
|
|
pnpm install
|
|
pnpm dev # watch worker + manifest + ui bundles
|
|
pnpm dev:ui # local UI preview server with hot-reload events
|
|
pnpm test
|
|
```
|