@caglarutkuguler/cubicle 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +19 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,6 +4,8 @@
4
4
 
5
5
  **[▶ Live demo](https://caglarutkuguler.github.io/cubicle/?lang=en)** — no install, fake agents.
6
6
 
7
+ [![npm](https://img.shields.io/npm/v/@caglarutkuguler/cubicle)](https://www.npmjs.com/package/@caglarutkuguler/cubicle) [![CI](https://github.com/caglarutkuguler/cubicle/actions/workflows/ci.yml/badge.svg)](https://github.com/caglarutkuguler/cubicle/actions/workflows/ci.yml) ![zero dependencies](https://img.shields.io/badge/dependencies-0-brightgreen) [![MIT](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
8
+
7
9
  Your agents get a desk. When one starts working it walks over, sits down and starts typing, with its current task floating above its head. When it needs you, it raises a hand. When it finishes it goes back to the lounge for a coffee. If it hits an error, its screen flashes red.
8
10
 
9
11
  [![Cubicle demo](docs/demo.gif)](https://caglarutkuguler.github.io/cubicle/?lang=en)
@@ -21,21 +23,21 @@ Requires Node.js 18+.
21
23
  **Paperclip** (default; expects Paperclip at `http://127.0.0.1:3100`):
22
24
 
23
25
  ```bash
24
- npx github:caglarutkuguler/cubicle
26
+ npx @caglarutkuguler/cubicle
25
27
  ```
26
28
 
27
29
  **Claude Code** (one character per session, driven by Claude Code's own hooks; details in [`examples/claude-code/`](examples/claude-code/)):
28
30
 
29
31
  ```bash
30
- npx github:caglarutkuguler/cubicle install-hooks # once; backs up ~/.claude/settings.json first
31
- npx github:caglarutkuguler/cubicle --source claude-code
32
+ npx @caglarutkuguler/cubicle install-hooks # once; backs up ~/.claude/settings.json first
33
+ npx @caglarutkuguler/cubicle --source claude-code
32
34
  ```
33
35
 
34
36
  **Anything else** — a JSON file or URL in the [feed format](docs/FEED.md):
35
37
 
36
38
  ```bash
37
- npx github:caglarutkuguler/cubicle --source ./agents.json
38
- npx github:caglarutkuguler/cubicle --source http://localhost:8080/agents
39
+ npx @caglarutkuguler/cubicle --source ./agents.json
40
+ npx @caglarutkuguler/cubicle --source http://localhost:8080/agents
39
41
  ```
40
42
 
41
43
  Then open <http://127.0.0.1:3200>. Nothing running yet? Open <http://127.0.0.1:3200/?demo>, or the [hosted demo](https://caglarutkuguler.github.io/cubicle/?lang=en).
@@ -83,9 +85,9 @@ Each card below the office links to the agent's current task when the source pro
83
85
  The default `local_trusted` mode needs no key. For an authenticated or remote Paperclip, give Cubicle an API key; it is sent as `Authorization: Bearer …` on the forwarded requests only:
84
86
 
85
87
  ```bash
86
- PAPERCLIP_URL=https://paperclip.example.com PAPERCLIP_TOKEN=pcp_… npx github:caglarutkuguler/cubicle
88
+ PAPERCLIP_URL=https://paperclip.example.com PAPERCLIP_TOKEN=pcp_… npx @caglarutkuguler/cubicle
87
89
  # or keep it in a file only you can read
88
- npx github:caglarutkuguler/cubicle --paperclip https://paperclip.example.com --token-file ~/.config/cubicle/paperclip-token
90
+ npx @caglarutkuguler/cubicle --paperclip https://paperclip.example.com --token-file ~/.config/cubicle/paperclip-token
89
91
  ```
90
92
 
91
93
  Use a board API key with the narrowest read-only scope Paperclip lets you create; an agent key also works but only sees that agent's company. There is no `--token` flag on purpose, because command-line flags are visible in the process list. With systemd, put `PAPERCLIP_TOKEN=…` in a `chmod 600` file and point `EnvironmentFile=` at it (see `examples/systemd/cubicle.service`).
@@ -131,6 +133,15 @@ journalctl --user -u cubicle-update.service # what it did
131
133
 
132
134
  Issues and pull requests are welcome. Ideas: adapters for other agent runtimes (write a feed, send a PR with an example), a kiosk mode for wall displays, meeting-room animations when agents hand work to each other, per-agent sprite customisation, replay of a recorded day, and multi-source offices (Paperclip and Claude Code on one floor).
133
135
 
136
+ ## Releasing
137
+
138
+ Versions are published to npm by [`.github/workflows/release.yml`](.github/workflows/release.yml) with npm trusted publishing, so no npm token exists anywhere and every version carries a provenance attestation.
139
+
140
+ ```bash
141
+ npm version patch # or minor / major: bumps package.json, commits, tags vX.Y.Z
142
+ git push --follow-tags # CI tests, publishes to npm, creates the GitHub release
143
+ ```
144
+
134
145
  ## Credits
135
146
 
136
147
  Inspired by the idea behind [Pixel Agents](https://github.com/pixel-agents-hq/pixel-agents) by Pablo De Lucca. Cubicle is an independent implementation and uses no code or assets from it.
@@ -147,4 +158,4 @@ Cubicle is a community project and is not affiliated with or endorsed by Papercl
147
158
 
148
159
  **Cubicle**, AI ajanlarınızı canlı bir pixel ofiste gösterir: [Paperclip](https://github.com/paperclipai/paperclip) ve Claude Code hazır gelir; başka sistemler küçük bir [JSON feed](docs/FEED.md) ile bağlanır. Çalışan ajan masasına oturup yazar ve başının üstünde görevi görünür; sizi bekleyen ajan elini kaldırır; işi biten ajan dinlenme alanına döner; hata alan ajanın ekranı kırmızı yanar.
149
160
 
150
- Kurulum: `npx github:caglarutkuguler/cubicle` (Paperclip) veya `npx github:caglarutkuguler/cubicle --source claude-code` (Claude Code) çalıştırın ve <http://127.0.0.1:3200> adresini açın. Kurmadan denemek için: [canlı demo](https://caglarutkuguler.github.io/cubicle/?lang=tr). Arayüz tarayıcı diline göre Türkçe açılır; `?lang=tr` ile de seçilebilir.
161
+ Kurulum: `npx @caglarutkuguler/cubicle` (Paperclip) veya `npx @caglarutkuguler/cubicle --source claude-code` (Claude Code) çalıştırın ve <http://127.0.0.1:3200> adresini açın. Kurmadan denemek için: [canlı demo](https://caglarutkuguler.github.io/cubicle/?lang=tr). Arayüz tarayıcı diline göre Türkçe açılır; `?lang=tr` ile de seçilebilir.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caglarutkuguler/cubicle",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "A live pixel-art office for your AI agents — Paperclip, Claude Code, or any JSON feed. Zero dependencies, read-only.",
5
5
  "bin": {
6
6
  "cubicle": "bin/cubicle.js"