@paneui/cli 0.0.5 → 0.0.6
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 +21 -15
- package/dist/argv.js +95 -7
- package/dist/commands/agent.js +41 -0
- package/dist/commands/artifact.js +31 -4
- package/dist/commands/blob-delete.js +37 -0
- package/dist/commands/blob-download.js +49 -0
- package/dist/commands/blob-list.js +50 -0
- package/dist/commands/blob-show.js +37 -0
- package/dist/commands/blob-token.js +133 -0
- package/dist/commands/blob-upload.js +79 -0
- package/dist/commands/blob.js +135 -0
- package/dist/commands/config.js +26 -7
- package/dist/commands/create.js +78 -12
- package/dist/commands/delete.js +7 -3
- package/dist/commands/feedback.js +6 -0
- package/dist/commands/{keys.js → key.js} +23 -17
- package/dist/commands/list.js +91 -0
- package/dist/commands/logout.js +10 -6
- package/dist/commands/participant.js +137 -0
- package/dist/commands/register.js +8 -4
- package/dist/commands/send.js +54 -6
- package/dist/commands/session.js +118 -0
- package/dist/commands/skill.js +20 -11
- package/dist/commands/state.js +9 -5
- package/dist/commands/taste.js +8 -0
- package/dist/commands/watch.js +10 -6
- package/dist/config.js +4 -4
- package/dist/index.js +85 -80
- package/dist/input.js +2 -2
- package/dist/output.js +1 -1
- package/dist/store.js +2 -2
- package/dist/version.js +1 -1
- package/package.json +4 -4
package/dist/config.js
CHANGED
|
@@ -49,15 +49,15 @@ export function describeConfig(args) {
|
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
51
|
* The hosted Pane relay. Used as the relay-URL fallback so a fresh user only
|
|
52
|
-
* needs an API key — `pane register` against the hosted relay, then go. A
|
|
53
|
-
* self-hoster overrides it with `--url` / `PANE_URL` / `pane register --url`.
|
|
52
|
+
* needs an API key — `pane agent register` against the hosted relay, then go. A
|
|
53
|
+
* self-hoster overrides it with `--url` / `PANE_URL` / `pane agent register --url`.
|
|
54
54
|
*/
|
|
55
55
|
export const DEFAULT_RELAY_URL = "https://relay.paneui.com";
|
|
56
56
|
/**
|
|
57
57
|
* Resolve relay URL + API key. Precedence (highest first):
|
|
58
58
|
* url: --url flag → PANE_URL env → store.url → DEFAULT_RELAY_URL
|
|
59
59
|
* apiKey: --api-key → PANE_API_KEY env → store.apiKey
|
|
60
|
-
* The store is written by `pane register`, so later commands need no env vars.
|
|
60
|
+
* The store is written by `pane agent register`, so later commands need no env vars.
|
|
61
61
|
*/
|
|
62
62
|
export function resolveConfig(args) {
|
|
63
63
|
const store = readStore();
|
|
@@ -67,7 +67,7 @@ export function resolveConfig(args) {
|
|
|
67
67
|
DEFAULT_RELAY_URL;
|
|
68
68
|
const apiKey = args.flags.get("api-key") ?? process.env.PANE_API_KEY ?? store.apiKey ?? "";
|
|
69
69
|
if (!apiKey) {
|
|
70
|
-
fail("missing API key: set PANE_API_KEY, pass --api-key <key>, or run 'pane register'", "config_error");
|
|
70
|
+
fail("missing API key: set PANE_API_KEY, pass --api-key <key>, or run 'pane agent register'", "config_error");
|
|
71
71
|
}
|
|
72
72
|
return { url: url.replace(/\/$/, ""), apiKey };
|
|
73
73
|
}
|
package/dist/index.js
CHANGED
|
@@ -1,21 +1,36 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
// pane — command-line client for the Pane relay.
|
|
3
3
|
//
|
|
4
|
+
// Shape: uniform `pane <noun> <verb> [options]`. Every command lives under a
|
|
5
|
+
// noun; nothing is a bare top-level verb. See issue #163 for the rationale
|
|
6
|
+
// behind the shape and the rename from the older flat layout.
|
|
7
|
+
//
|
|
4
8
|
// Config: PANE_URL and PANE_API_KEY (env), overridable with --url / --api-key.
|
|
5
|
-
// Output is JSON by default. Every
|
|
9
|
+
// Output is JSON by default. Every noun self-documents via --help.
|
|
6
10
|
import { parseArgs, ArgvError } from "./argv.js";
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
11
|
+
/**
|
|
12
|
+
* Translate an ArgvError into the canonical `invalid_args` envelope and exit
|
|
13
|
+
* non-zero. The parser throws ArgvError up-front; assertKnownFlags throws it
|
|
14
|
+
* from inside a runner. Both paths funnel here so the on-wire shape is one.
|
|
15
|
+
*/
|
|
16
|
+
function failArgvError(e) {
|
|
17
|
+
const error = {
|
|
18
|
+
code: "invalid_args",
|
|
19
|
+
message: e.message,
|
|
20
|
+
};
|
|
21
|
+
if (e.hint !== undefined)
|
|
22
|
+
error["hint"] = e.hint;
|
|
23
|
+
process.stderr.write(JSON.stringify({ error }) + "\n");
|
|
24
|
+
process.exit(1);
|
|
25
|
+
}
|
|
26
|
+
import { runSession, sessionHelp } from "./commands/session.js";
|
|
12
27
|
import { runArtifact, artifactHelp } from "./commands/artifact.js";
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import { runKeys, keysHelp } from "./commands/keys.js";
|
|
28
|
+
import { runAgent, agentHelp } from "./commands/agent.js";
|
|
29
|
+
import { runKey, keyHelp } from "./commands/key.js";
|
|
16
30
|
import { runTaste, tasteHelp } from "./commands/taste.js";
|
|
17
31
|
import { runFeedback, feedbackHelp } from "./commands/feedback.js";
|
|
18
|
-
import {
|
|
32
|
+
import { runConfig, configHelp } from "./commands/config.js";
|
|
33
|
+
import { runBlob, blobHelp } from "./commands/blob.js";
|
|
19
34
|
import { runSkill, skillHelp } from "./commands/skill.js";
|
|
20
35
|
import { VERSION } from "./version.js";
|
|
21
36
|
import { PaneApiError } from "@paneui/core";
|
|
@@ -23,39 +38,37 @@ import { failUpgradeRequired } from "./output.js";
|
|
|
23
38
|
const ROOT_HELP = `pane — a round-trip UI channel between agents and humans
|
|
24
39
|
|
|
25
40
|
Usage:
|
|
26
|
-
pane <
|
|
41
|
+
pane <noun> <verb> [options]
|
|
27
42
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
watch <id> Stream a session's events as JSON-lines on stdout
|
|
38
|
-
(long-lived; the building block for pipe-readers).
|
|
39
|
-
delete <id> Close/delete a session (DELETE /v1/sessions/:id).
|
|
40
|
-
keys Inspect or revoke YOUR agent's API key (list / revoke).
|
|
41
|
-
taste Read / write / clear YOUR agent's UI taste notes
|
|
42
|
-
(get / set / clear) — presentation preferences the agent
|
|
43
|
+
Nouns:
|
|
44
|
+
session Open / observe / send to / close sessions
|
|
45
|
+
(create | list | show | send | watch | delete |
|
|
46
|
+
participant <list|new|revoke>).
|
|
47
|
+
artifact Reusable, versioned UI templates
|
|
48
|
+
(create | version | update | search | list | show | delete).
|
|
49
|
+
key YOUR agent's API key (list | revoke).
|
|
50
|
+
taste YOUR agent's freeform UI taste notes
|
|
51
|
+
(get | set | clear) — presentation preferences the agent
|
|
43
52
|
has learned from human feedback and reads before
|
|
44
53
|
generating a pane artifact.
|
|
45
|
-
feedback
|
|
46
|
-
(create
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
54
|
+
feedback One-shot feedback to the relay operator
|
|
55
|
+
(create | list) — bug reports, feature requests, notes.
|
|
56
|
+
blob Binary attachments (upload | download | show | list |
|
|
57
|
+
delete | token <mint|revoke|list>). Blobs are scoped to
|
|
58
|
+
an agent, a session, or an artifact, and can be referenced
|
|
59
|
+
from event payloads + input_data via
|
|
60
|
+
\`format: pane-blob-id\`.
|
|
61
|
+
agent Agent identity on this machine (register | logout).
|
|
62
|
+
config CLI config inspection (show).
|
|
63
|
+
skill The relay's SKILL.md (show | version) — auto-updating;
|
|
64
|
+
no API key required.
|
|
52
65
|
|
|
53
|
-
Run \`pane <
|
|
66
|
+
Run \`pane <noun> --help\` for that noun's verbs.
|
|
54
67
|
|
|
55
68
|
Config:
|
|
56
69
|
PANE_URL Relay base URL. Override: --url <url>
|
|
57
70
|
PANE_API_KEY Agent API key. Override: --api-key <key>
|
|
58
|
-
'pane register' provisions the API key and saves it (with the URL) to
|
|
71
|
+
'pane agent register' provisions the API key and saves it (with the URL) to
|
|
59
72
|
\${XDG_CONFIG_HOME:-~/.config}/pane/config.json — afterwards commands need
|
|
60
73
|
only PANE_URL (or nothing) set.
|
|
61
74
|
|
|
@@ -72,7 +85,7 @@ Output: stdout is machine-readable JSON; errors go to stderr as
|
|
|
72
85
|
//
|
|
73
86
|
// `version` is deliberately NOT here: the top-level `-v` / `--version` is
|
|
74
87
|
// handled from rawArgv[0] before parseArgs runs, so it never needs to be a
|
|
75
|
-
// boolean flag — and keeping it out lets `pane create --version <n>` /
|
|
88
|
+
// boolean flag — and keeping it out lets `pane session create --version <n>` /
|
|
76
89
|
// `pane artifact version` consume a value as a normal value-flag.
|
|
77
90
|
const BOOLEAN_FLAGS = new Set([
|
|
78
91
|
"json",
|
|
@@ -89,12 +102,12 @@ async function main() {
|
|
|
89
102
|
process.stdout.write(VERSION + "\n");
|
|
90
103
|
return;
|
|
91
104
|
}
|
|
92
|
-
const
|
|
105
|
+
const noun = rawArgv[0];
|
|
93
106
|
const rest = rawArgv.slice(1);
|
|
94
|
-
if (
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
107
|
+
if (noun === undefined ||
|
|
108
|
+
noun === "-h" ||
|
|
109
|
+
noun === "--help" ||
|
|
110
|
+
noun === "help") {
|
|
98
111
|
process.stdout.write(ROOT_HELP + "\n");
|
|
99
112
|
return;
|
|
100
113
|
}
|
|
@@ -104,65 +117,47 @@ async function main() {
|
|
|
104
117
|
}
|
|
105
118
|
catch (e) {
|
|
106
119
|
if (e instanceof ArgvError) {
|
|
107
|
-
|
|
108
|
-
error: { code: "invalid_args", message: e.message },
|
|
109
|
-
}) + "\n");
|
|
110
|
-
process.exit(1);
|
|
120
|
+
failArgvError(e);
|
|
111
121
|
}
|
|
112
122
|
throw e;
|
|
113
123
|
}
|
|
114
124
|
const helps = {
|
|
115
|
-
|
|
116
|
-
create: createHelp,
|
|
125
|
+
session: sessionHelp,
|
|
117
126
|
artifact: artifactHelp,
|
|
118
|
-
|
|
119
|
-
send: sendHelp,
|
|
120
|
-
watch: watchHelp,
|
|
121
|
-
delete: deleteHelp,
|
|
122
|
-
keys: keysHelp,
|
|
127
|
+
key: keyHelp,
|
|
123
128
|
taste: tasteHelp,
|
|
124
129
|
feedback: feedbackHelp,
|
|
130
|
+
blob: blobHelp,
|
|
131
|
+
agent: agentHelp,
|
|
125
132
|
config: configHelp,
|
|
126
|
-
logout: logoutHelp,
|
|
127
133
|
skill: skillHelp,
|
|
128
134
|
};
|
|
129
|
-
if (!(
|
|
135
|
+
if (!(noun in helps)) {
|
|
130
136
|
process.stderr.write(JSON.stringify({
|
|
131
137
|
error: {
|
|
132
138
|
code: "unknown_command",
|
|
133
|
-
message: `unknown command '${
|
|
139
|
+
message: `unknown command '${noun}' — run 'pane --help'`,
|
|
134
140
|
},
|
|
135
141
|
}) + "\n");
|
|
136
142
|
process.exit(1);
|
|
137
143
|
}
|
|
138
|
-
|
|
139
|
-
|
|
144
|
+
// `pane <noun> --help` with no verb prints the noun-level help. A verb-level
|
|
145
|
+
// --help is the responsibility of each runner (e.g. runSession dispatches to
|
|
146
|
+
// the verb runner which reads its own xxxHelp). This pre-empt only fires
|
|
147
|
+
// when --help is the FIRST positional-equivalent — i.e. no verb given.
|
|
148
|
+
if (args.bools.has("help") && args.positionals.length === 0) {
|
|
149
|
+
process.stdout.write(helps[noun] + "\n");
|
|
140
150
|
return;
|
|
141
151
|
}
|
|
142
|
-
switch (
|
|
143
|
-
case "
|
|
144
|
-
await
|
|
145
|
-
break;
|
|
146
|
-
case "create":
|
|
147
|
-
await runCreate(args);
|
|
152
|
+
switch (noun) {
|
|
153
|
+
case "session":
|
|
154
|
+
await runSession(args);
|
|
148
155
|
break;
|
|
149
156
|
case "artifact":
|
|
150
157
|
await runArtifact(args);
|
|
151
158
|
break;
|
|
152
|
-
case "
|
|
153
|
-
await
|
|
154
|
-
break;
|
|
155
|
-
case "send":
|
|
156
|
-
await runSend(args);
|
|
157
|
-
break;
|
|
158
|
-
case "watch":
|
|
159
|
-
await runWatch(args);
|
|
160
|
-
break;
|
|
161
|
-
case "delete":
|
|
162
|
-
await runDelete(args);
|
|
163
|
-
break;
|
|
164
|
-
case "keys":
|
|
165
|
-
await runKeys(args);
|
|
159
|
+
case "key":
|
|
160
|
+
await runKey(args);
|
|
166
161
|
break;
|
|
167
162
|
case "taste":
|
|
168
163
|
await runTaste(args);
|
|
@@ -170,18 +165,28 @@ async function main() {
|
|
|
170
165
|
case "feedback":
|
|
171
166
|
await runFeedback(args);
|
|
172
167
|
break;
|
|
168
|
+
case "blob":
|
|
169
|
+
await runBlob(args);
|
|
170
|
+
break;
|
|
171
|
+
case "agent":
|
|
172
|
+
await runAgent(args);
|
|
173
|
+
break;
|
|
173
174
|
case "config":
|
|
174
175
|
await runConfig(args);
|
|
175
176
|
break;
|
|
176
|
-
case "logout":
|
|
177
|
-
await runLogout();
|
|
178
|
-
break;
|
|
179
177
|
case "skill":
|
|
180
178
|
await runSkill(args);
|
|
181
179
|
break;
|
|
182
180
|
}
|
|
183
181
|
}
|
|
184
182
|
main().catch((err) => {
|
|
183
|
+
// ArgvError thrown from a runner (e.g. assertKnownFlags) reaches here —
|
|
184
|
+
// funnel it through the same invalid_args envelope as the parse-time path
|
|
185
|
+
// so unknown-flag rejection looks identical no matter which layer caught
|
|
186
|
+
// the user error.
|
|
187
|
+
if (err instanceof ArgvError) {
|
|
188
|
+
failArgvError(err);
|
|
189
|
+
}
|
|
185
190
|
// Funnel 426 cli_upgrade_required through the dedicated upgrade-message
|
|
186
191
|
// path so a command that throws raw (instead of going through
|
|
187
192
|
// failFromError) still produces the exact stderr block + exit 75 the
|
package/dist/input.js
CHANGED
|
@@ -17,7 +17,7 @@ function isFilePath(value) {
|
|
|
17
17
|
return false;
|
|
18
18
|
}
|
|
19
19
|
const code = e && typeof e === "object" ? e.code : undefined;
|
|
20
|
-
throw new Error(`cannot stat '${value}'${code ? ` (${code})` : ""}: ${e instanceof Error ? e.message : String(e)}
|
|
20
|
+
throw new Error(`cannot stat '${value}'${code ? ` (${code})` : ""}: ${e instanceof Error ? e.message : String(e)}`, { cause: e });
|
|
21
21
|
}
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
@@ -30,7 +30,7 @@ export function resolveJson(value, label) {
|
|
|
30
30
|
return JSON.parse(raw);
|
|
31
31
|
}
|
|
32
32
|
catch (e) {
|
|
33
|
-
throw new Error(`${label}: not valid JSON (${e instanceof Error ? e.message : String(e)})
|
|
33
|
+
throw new Error(`${label}: not valid JSON (${e instanceof Error ? e.message : String(e)})`, { cause: e });
|
|
34
34
|
}
|
|
35
35
|
}
|
|
36
36
|
/**
|
package/dist/output.js
CHANGED
|
@@ -8,7 +8,7 @@ export function printJson(value) {
|
|
|
8
8
|
process.stdout.write(JSON.stringify(value, null, 2) + "\n");
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* Print a single compact JSON line to stdout and flush. Used by `pane watch`
|
|
11
|
+
* Print a single compact JSON line to stdout and flush. Used by `pane session watch`
|
|
12
12
|
* so a pipe-reader (e.g. Claude Code's Monitor tool) sees each event
|
|
13
13
|
* immediately, one event per line.
|
|
14
14
|
*/
|
package/dist/store.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Persisted CLI config: ${XDG_CONFIG_HOME or ~/.config}/pane/config.json.
|
|
2
2
|
//
|
|
3
|
-
// Holds the relay URL and the agent API key obtained via `pane register`, so
|
|
3
|
+
// Holds the relay URL and the agent API key obtained via `pane agent register`, so
|
|
4
4
|
// later commands need no env vars. The file holds a secret — it is written
|
|
5
5
|
// 0600. Tiny and synchronous; no deps.
|
|
6
6
|
import { readFileSync, writeFileSync, mkdirSync, chmodSync, rmSync, } from "node:fs";
|
|
@@ -55,7 +55,7 @@ export function writeStore(patch) {
|
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
57
|
* Delete the persisted config file (URL + API key). Idempotent — no error if
|
|
58
|
-
* the file never existed. Returns the path it targeted. Used by `pane logout`.
|
|
58
|
+
* the file never existed. Returns the path it targeted. Used by `pane agent logout`.
|
|
59
59
|
*/
|
|
60
60
|
export function clearStore() {
|
|
61
61
|
const path = storePath();
|
package/dist/version.js
CHANGED
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
// Keep this in lockstep with packages/cli/package.json's `version` field;
|
|
9
9
|
// they're consulted in different places (here for the runtime header,
|
|
10
10
|
// package.json for npm publish + dependency resolution).
|
|
11
|
-
export const VERSION = "0.0.
|
|
11
|
+
export const VERSION = "0.0.6";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@paneui/cli",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.6",
|
|
4
4
|
"description": "Command-line client for the Pane relay: create sessions, inspect state, send and watch events.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -41,11 +41,11 @@
|
|
|
41
41
|
"test:unit": "vitest run"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@paneui/core": "^0.0.
|
|
44
|
+
"@paneui/core": "^0.0.6"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@types/node": "^
|
|
48
|
-
"typescript": "^
|
|
47
|
+
"@types/node": "^25.9.1",
|
|
48
|
+
"typescript": "^6.0.3",
|
|
49
49
|
"vitest": "^4.1.6"
|
|
50
50
|
}
|
|
51
51
|
}
|