@rwoll/canvas-kit 0.1.0 → 0.1.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.
- package/README.md +32 -8
- package/cli/release.json +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,29 @@
|
|
|
1
1
|
# @rwoll/canvas-kit
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
3
|
+
**Copilot canvases you can change, test, and share.** Build the release boards,
|
|
4
|
+
triage queues, and review tools that you and your agent work in together: state
|
|
5
|
+
and actions in TypeScript, UI in React, and canvas-kit handles the rest.
|
|
6
|
+
|
|
7
|
+
- **React components.** Typed hooks wire your components to live state; share them
|
|
8
|
+
across canvases to stay on brand.
|
|
9
|
+
- **Live, two-way canvases.** The agent's changes appear instantly, it reads yours,
|
|
10
|
+
and a button can hand it the next task.
|
|
11
|
+
- **Saved, shared documents.** One board per repository: every chat on the release
|
|
12
|
+
updates it, and tomorrow's chat picks up where today's left off.
|
|
13
|
+
- **Scheduled jobs.** Refresh pull request checks every 15 minutes or prune last
|
|
14
|
+
week's triaged tests, even with no chat open. Users can pause or retime them.
|
|
15
|
+
- **A fast dev loop.** Preview changes live in your browser with no reinstalling,
|
|
16
|
+
then test as the agent and the user with Playwright.
|
|
17
|
+
- **Share with one push.** `git push` publishes your canvases, skills, agents, and
|
|
18
|
+
MCP servers for your users to install in two commands.
|
|
19
|
+
|
|
20
|
+
For a one-off view, plain HTML is fine. canvas-kit is for canvases you keep and
|
|
21
|
+
share. See the [project README](https://github.com/rwoll/canvas-kit#readme) for
|
|
22
|
+
screenshots and example canvases.
|
|
23
|
+
|
|
24
|
+
A canvas is an interactive panel that the agent opens with `open_canvas` and
|
|
25
|
+
drives with `invoke_canvas_action`. A canvas package declares its state and
|
|
26
|
+
actions once, and the kit supplies everything else. This guide covers the API.
|
|
7
27
|
|
|
8
28
|
## Quickstart
|
|
9
29
|
|
|
@@ -251,15 +271,19 @@ so it is safe while chats have the canvas open.
|
|
|
251
271
|
|
|
252
272
|
```sh
|
|
253
273
|
# In a canvas package after `pnpm build`, or with --plugin for an installed plugin
|
|
254
|
-
npx canvas-kit run
|
|
255
|
-
npx canvas-kit run prune_triaged --plugin ~/.copilot/installed-plugins/my-marketplace/flaky-tests
|
|
274
|
+
npx @rwoll/canvas-kit run
|
|
275
|
+
npx @rwoll/canvas-kit run prune_triaged --plugin ~/.copilot/installed-plugins/my-marketplace/flaky-tests
|
|
256
276
|
```
|
|
257
277
|
|
|
278
|
+
In a canvas package, `npx` runs the `@rwoll/canvas-kit` it installed; elsewhere it
|
|
279
|
+
downloads it. Always give the scoped name: the unscoped `canvas-kit` on npm is a
|
|
280
|
+
different package.
|
|
281
|
+
|
|
258
282
|
Run it at least as often as the shortest interval users may pick. For example,
|
|
259
283
|
every 15 minutes with cron (`crontab -e`):
|
|
260
284
|
|
|
261
285
|
```text
|
|
262
|
-
*/15 * * * * cd ~/canvases/flaky-tests && npx canvas-kit run >> /tmp/flaky-tests-jobs.log 2>&1
|
|
286
|
+
*/15 * * * * cd ~/canvases/flaky-tests && npx @rwoll/canvas-kit run >> /tmp/flaky-tests-jobs.log 2>&1
|
|
263
287
|
```
|
|
264
288
|
|
|
265
289
|
Or with a launchd agent on macOS, in `~/Library/LaunchAgents/com.example.flaky-tests-jobs.plist`, loaded
|
|
@@ -273,7 +297,7 @@ with `launchctl load ~/Library/LaunchAgents/com.example.flaky-tests-jobs.plist`:
|
|
|
273
297
|
<key>Label</key><string>com.example.flaky-tests-jobs</string>
|
|
274
298
|
<key>WorkingDirectory</key><string>/Users/me/canvases/flaky-tests</string>
|
|
275
299
|
<key>ProgramArguments</key>
|
|
276
|
-
<array><string>/opt/homebrew/bin/npx</string><string
|
|
300
|
+
<array><string>/opt/homebrew/bin/npx</string><string>@rwoll/canvas-kit</string><string>run</string></array>
|
|
277
301
|
<key>StartInterval</key><integer>900</integer>
|
|
278
302
|
</dict>
|
|
279
303
|
</plist>
|
package/cli/release.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rwoll/canvas-kit",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Build Copilot canvas extensions with TypeScript and React: typed state and actions, a secure local host, a Vite build, test helpers, and marketplace publishing.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"copilot",
|