|
15 | 15 |
|
16 | 16 | Paperclip Aperture treats Paperclip as the host runtime and UI shell, while importing [Aperture Core](https://github.com/tomismeta/aperture/tree/main/packages/core) via the npm package [`@tomismeta/aperture-core`](https://www.npmjs.com/package/@tomismeta/aperture-core). |
17 | 17 |
|
18 | | -It turns Paperclip approvals, issue activity, and other operator-facing events into an Aperture-style attention surface: |
| 18 | +It turns Paperclip approvals, issue activity, and other operator-facing events into a Focus surface that ranks what deserves attention now, next, and ambient. |
19 | 19 |
|
20 | | -```text |
21 | | -+------------------+ +-------------------+ +-------------------+ +------------------+ +------------------+ |
22 | | -| Paperclip events | --> | Plugin translates | --> | Aperture judges | --> | Paperclip renders| --> | Human responds | |
23 | | -| approvals | | explicit facts | | now / next / | | attention UI | | into host action | |
24 | | -| issues | | from host payloads| | ambient | | + operator tools | | approve / reject | |
25 | | -| run failures | | | | | | | | acknowledge | |
26 | | -+------------------+ +-------------------+ +-------------------+ +------------------+ +------------------+ |
27 | | -``` |
28 | | - |
29 | | -Links: |
30 | | - |
31 | | -- Aperture core on npm: [`@tomismeta/aperture-core`](https://www.npmjs.com/package/@tomismeta/aperture-core) |
32 | | -- Aperture GitHub repo: [tomismeta/aperture](https://github.com/tomismeta/aperture) |
33 | | -- Paperclip GitHub repo: [paperclipai/paperclip](https://github.com/paperclipai/paperclip) |
| 20 | +## Install |
34 | 21 |
|
35 | | -## Start Here |
36 | | - |
37 | | -Choose one path: |
38 | | - |
39 | | -- **install the plugin locally** if you want to run it in Paperclip today |
40 | | -- **run the demo** if you want a short live walkthrough |
41 | | -- **read the architecture** if you want to understand how Aperture is embedded inside the plugin |
| 22 | +This plugin is not yet published to npm. |
42 | 23 |
|
43 | | -### Run The Demo |
| 24 | +Today, the supported path is a local-path install into a running Paperclip instance. |
44 | 25 |
|
45 | | -Use the live demo guide in [docs/DEMO.md](./docs/DEMO.md). |
| 26 | +If Paperclip is already running, the shortest path is: |
46 | 27 |
|
47 | | -### Install The Plugin Locally |
| 28 | +```bash |
| 29 | +git clone git@github.com:tomismeta/paperclip-aperture.git |
| 30 | +cd paperclip-aperture |
| 31 | +pnpm install |
| 32 | +pnpm build |
48 | 33 |
|
49 | | -This plugin is not yet published to npm. |
| 34 | +cd /path/to/paperclip |
| 35 | +pnpm paperclipai plugin install /absolute/path/to/paperclip-aperture |
| 36 | +``` |
50 | 37 |
|
51 | | -Today, the supported path is a local-path plugin install into a Paperclip instance: |
| 38 | +If you need to start Paperclip first: |
52 | 39 |
|
53 | 40 | ```bash |
54 | 41 | git clone git@github.com:tomismeta/paperclip-aperture.git |
@@ -82,22 +69,12 @@ Then open Paperclip and navigate to: |
82 | 69 | - `Settings -> Plugins -> Paperclip Aperture` |
83 | 70 | - `/<company-prefix>/aperture` |
84 | 71 |
|
85 | | -Future install shape once this plugin is published: |
| 72 | +Once this plugin is published to npm, the install shape becomes: |
86 | 73 |
|
87 | 74 | ```bash |
88 | 75 | pnpm paperclipai plugin install @tomismeta/paperclip-aperture |
89 | 76 | ``` |
90 | 77 |
|
91 | | -### Understand The Embedding Model |
92 | | - |
93 | | -The architecture is host-first: |
94 | | - |
95 | | -- host/runtime: Paperclip |
96 | | -- judgment engine: Aperture |
97 | | -- plugin artifact: `@tomismeta/paperclip-aperture` |
98 | | - |
99 | | -The goal is to prove that Aperture can live inside Paperclip as a normal plugin, without changing Aperture core. |
100 | | - |
101 | 78 | ## What This Plugin Is |
102 | 79 |
|
103 | 80 | Paperclip Aperture is an alternative operator attention surface for Paperclip. |
@@ -199,6 +176,13 @@ pnpm test |
199 | 176 |
|
200 | 177 | This repo uses the published Paperclip SDK packages directly and is being prepared for npm distribution as a normal installable plugin artifact. |
201 | 178 |
|
| 179 | +## Links |
| 180 | + |
| 181 | +- Aperture core on npm: [`@tomismeta/aperture-core`](https://www.npmjs.com/package/@tomismeta/aperture-core) |
| 182 | +- Aperture GitHub repo: [tomismeta/aperture](https://github.com/tomismeta/aperture) |
| 183 | +- Paperclip GitHub repo: [paperclipai/paperclip](https://github.com/paperclipai/paperclip) |
| 184 | +- Demo guide: [docs/DEMO.md](./docs/DEMO.md) |
| 185 | + |
202 | 186 | ## Status |
203 | 187 |
|
204 | 188 | This is a working integration prototype. |
|
0 commit comments