@clickminded/coauthor-cli 0.0.11 → 0.0.12
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 +49 -106
- package/dist/client.d.ts +1 -0
- package/dist/client.js +2 -2
- package/dist/commands.js +35 -26
- package/dist/config.d.ts +1 -1
- package/dist/config.js +1 -1
- package/dist/index.js +6 -4
- package/dist/parser.js +1 -1
- package/package.json +3 -3
- package/skills/agents/SKILL.md +2 -2
- package/skills/claude/SKILL.md +2 -2
- package/skills/codex/SKILL.md +2 -2
- package/skills/cursor/coauthor-cli.mdc +2 -2
package/README.md
CHANGED
|
@@ -1,16 +1,13 @@
|
|
|
1
1
|
# CoAuthor CLI
|
|
2
2
|
|
|
3
|
-
`@clickminded/coauthor-cli` installs the `coauthor` command for working with CoAuthor projects from a terminal or from AI coding agents such as Codex, Claude Code, and
|
|
3
|
+
`@clickminded/coauthor-cli` installs the `coauthor` command for working with CoAuthor projects from a terminal or from AI coding agents such as Codex, Claude Code, Cursor, and other local agents.
|
|
4
4
|
|
|
5
|
-
The CLI
|
|
5
|
+
The CLI connects to CoAuthor at `https://tools.clickminded.com/coauthor`. Your projects stay private and every project command requires browser/device login.
|
|
6
6
|
|
|
7
7
|
## Requirements
|
|
8
8
|
|
|
9
9
|
- Node.js 20 or newer.
|
|
10
|
-
- A CoAuthor account.
|
|
11
|
-
- The base URL for the CoAuthor workspace you want to use.
|
|
12
|
-
|
|
13
|
-
CoAuthor server setup, database migrations, and web app environment variables are maintainer/deployment concerns. They are not required for normal CLI users.
|
|
10
|
+
- A CoAuthor account with access to CoAuthor.
|
|
14
11
|
|
|
15
12
|
## Install
|
|
16
13
|
|
|
@@ -18,7 +15,6 @@ Install globally:
|
|
|
18
15
|
|
|
19
16
|
```sh
|
|
20
17
|
npm install -g @clickminded/coauthor-cli
|
|
21
|
-
coauthor auth status
|
|
22
18
|
```
|
|
23
19
|
|
|
24
20
|
Or run without a global install:
|
|
@@ -27,35 +23,23 @@ Or run without a global install:
|
|
|
27
23
|
npx @clickminded/coauthor-cli help
|
|
28
24
|
```
|
|
29
25
|
|
|
30
|
-
##
|
|
26
|
+
## Sign In
|
|
31
27
|
|
|
32
28
|
Start browser/device login:
|
|
33
29
|
|
|
34
30
|
```sh
|
|
35
|
-
coauthor auth login
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
For example, when testing against a local CoAuthor app:
|
|
39
|
-
|
|
40
|
-
```sh
|
|
41
|
-
coauthor auth login --base-url http://localhost:3000
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Request publish/export permission during login:
|
|
45
|
-
|
|
46
|
-
```sh
|
|
47
|
-
coauthor auth login --base-url <coauthor-app-url> --with-publish
|
|
31
|
+
coauthor auth login
|
|
48
32
|
```
|
|
49
33
|
|
|
50
|
-
The CLI opens a browser approval page.
|
|
34
|
+
The CLI opens a browser approval page. After approval, it stores a scoped local token for your signed-in CoAuthor account.
|
|
51
35
|
|
|
52
|
-
Check
|
|
36
|
+
Check your login:
|
|
53
37
|
|
|
54
38
|
```sh
|
|
55
39
|
coauthor auth status --json
|
|
56
40
|
```
|
|
57
41
|
|
|
58
|
-
Log out and
|
|
42
|
+
Log out and revoke the local token:
|
|
59
43
|
|
|
60
44
|
```sh
|
|
61
45
|
coauthor auth logout
|
|
@@ -63,20 +47,6 @@ coauthor auth logout
|
|
|
63
47
|
|
|
64
48
|
Local credentials are stored at `~/.coauthor/config.json` with best-effort `0600` permissions. Do not print, paste, or commit this file.
|
|
65
49
|
|
|
66
|
-
Environment variables override the config file:
|
|
67
|
-
|
|
68
|
-
```sh
|
|
69
|
-
COAUTHOR_BASE_URL=<coauthor-app-url>
|
|
70
|
-
COAUTHOR_TOKEN=coauthor_xxx
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
Global options are:
|
|
74
|
-
|
|
75
|
-
- `--json` for machine-readable output.
|
|
76
|
-
- `--base-url <url>` to target a specific CoAuthor app.
|
|
77
|
-
- `--token <token>` for non-persistent token injection.
|
|
78
|
-
- `--data '<json>'` to send command-specific JSON request bodies.
|
|
79
|
-
|
|
80
50
|
## Agent Skills
|
|
81
51
|
|
|
82
52
|
Install agent instructions after installing the CLI:
|
|
@@ -101,34 +71,32 @@ Default install paths are:
|
|
|
101
71
|
- Cursor: `./.cursor/rules/coauthor-cli.mdc`
|
|
102
72
|
- Agents: `./.agents/skills/coauthor/SKILL.md`
|
|
103
73
|
|
|
104
|
-
Use `--dry-run` to preview, `--force` to overwrite existing files, and `--cwd <path>` to install project-local Claude
|
|
74
|
+
Use `--dry-run` to preview, `--force` to overwrite existing files, and `--cwd <path>` to install project-local Claude, Cursor, or Agents skills into a specific project.
|
|
105
75
|
|
|
106
|
-
Skill installs are recorded in `~/.config/coauthor/managed-skills.json`. Future
|
|
76
|
+
Skill installs are recorded in `~/.config/coauthor/managed-skills.json`. Future package updates automatically refresh recorded skill files when they still match the previously installed template. If you edit a skill file by hand, the auto-update leaves it alone until you run `coauthor skills install <target> --force`.
|
|
107
77
|
|
|
108
78
|
## Common Commands
|
|
109
79
|
|
|
110
|
-
|
|
80
|
+
Create and inspect projects:
|
|
111
81
|
|
|
112
82
|
```sh
|
|
113
|
-
coauthor project create --topic "
|
|
83
|
+
coauthor project create --title "Post title" --topic "Post brief" --audience "Target reader" --json
|
|
114
84
|
coauthor project list --json
|
|
115
85
|
coauthor project show <project-id> --json
|
|
116
86
|
coauthor workspace show <project-id> --json
|
|
117
87
|
```
|
|
118
88
|
|
|
119
|
-
|
|
89
|
+
Work with the project:
|
|
120
90
|
|
|
121
91
|
```sh
|
|
122
|
-
coauthor chat <project-id> --message "
|
|
92
|
+
coauthor chat <project-id> --message "Refine the angle for this post" --json
|
|
123
93
|
coauthor workflow status <project-id> --json
|
|
124
94
|
coauthor workflow run <project-id> --target draft --wait --json
|
|
125
95
|
coauthor workflow resume <project-id> --target draft --wait --json
|
|
126
|
-
coauthor workflow rewind <project-id> --stage outline --reason "..." --json
|
|
127
|
-
coauthor workflow approve <project-id> --stage research_plan --json
|
|
128
96
|
coauthor credits <project-id> --json
|
|
129
97
|
```
|
|
130
98
|
|
|
131
|
-
|
|
99
|
+
Read or generate artifacts:
|
|
132
100
|
|
|
133
101
|
```sh
|
|
134
102
|
coauthor contract show <project-id> --json
|
|
@@ -137,64 +105,61 @@ coauthor research-plan generate <project-id> --json
|
|
|
137
105
|
coauthor research run <project-id> --wait --json
|
|
138
106
|
coauthor draft generate <project-id> --wait --json
|
|
139
107
|
coauthor draft get <project-id> --format markdown --json
|
|
140
|
-
coauthor draft get <project-id> --format html --json
|
|
141
|
-
coauthor draft get <project-id> --format text --json
|
|
142
|
-
coauthor draft get <project-id> --format json --json
|
|
143
108
|
```
|
|
144
109
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
Images and threads:
|
|
110
|
+
Images and social content:
|
|
148
111
|
|
|
149
112
|
```sh
|
|
150
113
|
coauthor image list <project-id> --json
|
|
151
|
-
coauthor image generate <project-id> --placeholder-id <placeholder-id> --prompt "
|
|
114
|
+
coauthor image generate <project-id> --placeholder-id <placeholder-id> --prompt "Image direction" --json
|
|
152
115
|
coauthor thread generate <project-id> --json
|
|
153
|
-
coauthor thread save <project-id> --data '{"posts":[]}' --json
|
|
154
116
|
```
|
|
155
117
|
|
|
156
|
-
|
|
118
|
+
Use `--json` when another tool or agent needs to parse command output. Use `--wait` when starting longer-running work and you want the command to wait for completion.
|
|
119
|
+
|
|
120
|
+
## Draft Export
|
|
121
|
+
|
|
122
|
+
Export a finished draft in the format you need:
|
|
157
123
|
|
|
158
124
|
```sh
|
|
159
|
-
coauthor
|
|
160
|
-
coauthor
|
|
161
|
-
coauthor
|
|
162
|
-
coauthor
|
|
125
|
+
coauthor draft get <project-id> --format markdown --json
|
|
126
|
+
coauthor draft get <project-id> --format html --json
|
|
127
|
+
coauthor draft get <project-id> --format text --json
|
|
128
|
+
coauthor draft get <project-id> --format json --json
|
|
163
129
|
```
|
|
164
130
|
|
|
165
|
-
|
|
131
|
+
Markdown, HTML, and text exports resolve generated image URLs when images are available. Use `--format json` or omit `--format` for the raw editor document JSON.
|
|
166
132
|
|
|
167
|
-
##
|
|
133
|
+
## Live Actions
|
|
168
134
|
|
|
169
|
-
|
|
135
|
+
Publishing and external exports are real side effects. The default login grants project/workflow access only. To run live publish/export commands, sign in with publish permission:
|
|
170
136
|
|
|
171
137
|
```sh
|
|
172
|
-
coauthor
|
|
173
|
-
coauthor workflow run <project-id> --target outline --briefing-mode strict --max-brief-questions 2 --json
|
|
138
|
+
coauthor auth login --with-publish
|
|
174
139
|
```
|
|
175
140
|
|
|
176
|
-
|
|
141
|
+
Then run live actions only when you mean to publish or export:
|
|
177
142
|
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
-
|
|
143
|
+
```sh
|
|
144
|
+
coauthor publish thread <project-id> --yes --json
|
|
145
|
+
coauthor export blog <project-id> --yes --slug "post-slug" --json
|
|
146
|
+
coauthor export clickminded <project-id> --yes --json
|
|
147
|
+
coauthor operation status <operation-key> --json
|
|
148
|
+
```
|
|
181
149
|
|
|
182
|
-
|
|
150
|
+
Live actions require both publish scope and `--yes`.
|
|
183
151
|
|
|
184
152
|
## Agent Usage Rules
|
|
185
153
|
|
|
186
154
|
Agents should:
|
|
187
155
|
|
|
188
|
-
- Prefer `coauthor` over browser automation,
|
|
189
|
-
- Use `--json`
|
|
190
|
-
- Use `--wait` when starting
|
|
191
|
-
- Treat `status: "requires_key"` as a recoverable pause
|
|
192
|
-
- Treat `status: "research_running_stale"`
|
|
193
|
-
-
|
|
194
|
-
-
|
|
195
|
-
- Avoid retrying publish/export after uncertain network failures.
|
|
196
|
-
- Use `coauthor operation status <operation-key>` after uncertainty.
|
|
197
|
-
- Never print tokens, cookies, service-role keys, provider API keys, or authorization headers.
|
|
156
|
+
- Prefer `coauthor` commands over browser automation, hand-written HTTP requests, or direct database access.
|
|
157
|
+
- Use `--json` for machine-readable output.
|
|
158
|
+
- Use `--wait` when starting asynchronous work and the user expects the result.
|
|
159
|
+
- Treat `status: "requires_key"` or `paused_requires_key` as a recoverable pause. Ask the user to add the required provider key in CoAuthor AI settings, then resume with `coauthor workflow resume <project-id> --wait --json`.
|
|
160
|
+
- Treat `status: "research_running_stale"` as a stale research run and inspect `coauthor research structured <project-id> --json` before retrying.
|
|
161
|
+
- Check operation status after timeouts, interruptions, network errors, or uncertain live-action results.
|
|
162
|
+
- Never print tokens, cookies, provider keys, service-role keys, or authorization headers.
|
|
198
163
|
|
|
199
164
|
## Security
|
|
200
165
|
|
|
@@ -204,38 +169,16 @@ Agents should:
|
|
|
204
169
|
- Tokens are stored locally at `~/.coauthor/config.json`.
|
|
205
170
|
- Run `coauthor auth logout` to revoke the current token and remove local credentials.
|
|
206
171
|
|
|
207
|
-
## Public API Stability
|
|
208
|
-
|
|
209
|
-
The CLI talks to `/api/agent/v1/*`. Treat this as a public beta API surface:
|
|
210
|
-
|
|
211
|
-
- Existing commands should keep stable JSON envelopes.
|
|
212
|
-
- New behavior should be additive when possible.
|
|
213
|
-
- Errors should stay structured and machine-readable with `--json`.
|
|
214
|
-
- Server-side auth, ownership checks, scopes, and rate limits remain mandatory.
|
|
215
|
-
|
|
216
172
|
## Troubleshooting
|
|
217
173
|
|
|
218
|
-
`No token configured` means the CLI has no
|
|
174
|
+
`No token configured` means the CLI has no saved CoAuthor credential. Run `coauthor auth login`.
|
|
219
175
|
|
|
220
|
-
`insufficient_scope` means the token does not include the required scope. For publish/export, log in again with
|
|
176
|
+
`insufficient_scope` means the token does not include the required scope. For publish/export, log in again with `coauthor auth login --with-publish`.
|
|
221
177
|
|
|
222
|
-
`authorization_pending` during login is normal while the browser approval page is waiting for
|
|
178
|
+
`authorization_pending` during login is normal while the browser approval page is waiting for approval.
|
|
223
179
|
|
|
224
|
-
`requires_key` means included credits are exhausted and no usable provider key is configured for the requested capability.
|
|
180
|
+
`requires_key` means included credits are exhausted and no usable provider key is configured for the requested capability. Open CoAuthor AI settings, add the required key, then run `coauthor workflow resume <project-id> --wait --json`.
|
|
225
181
|
|
|
226
182
|
`research_running_stale` means a research run is still marked running beyond the expected progress window. Inspect `coauthor research structured <project-id> --json`; if it only contains empty section shells, rewind research or report the stale run instead of repeatedly resuming.
|
|
227
183
|
|
|
228
184
|
Image generation requires an existing image placeholder. Run `coauthor image list <project-id> --json` after draft generation and pass the placeholder id to `coauthor image generate <project-id> --placeholder-id <placeholder-id> --json`.
|
|
229
|
-
|
|
230
|
-
If `npx @clickminded/coauthor-cli help` fails while you are inside the CLI package source directory, run it from another directory or use:
|
|
231
|
-
|
|
232
|
-
```sh
|
|
233
|
-
npm exec --package=@clickminded/coauthor-cli@latest -- coauthor-cli help
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
## For CoAuthor Maintainers
|
|
237
|
-
|
|
238
|
-
This README is written for public CLI users. Maintainer/deployment details such as database migrations, `COAUTHOR_API_TOKEN_PEPPER`, local monorepo development, and npm Trusted Publishing live in the CoAuthor repository docs:
|
|
239
|
-
|
|
240
|
-
- `docs/agent-cli.md`
|
|
241
|
-
- `docs/skills.md`
|
package/dist/client.d.ts
CHANGED
package/dist/client.js
CHANGED
|
@@ -23,7 +23,7 @@ export class AgentClient {
|
|
|
23
23
|
token;
|
|
24
24
|
fetchImpl;
|
|
25
25
|
constructor(options) {
|
|
26
|
-
this.baseUrl = new URL('
|
|
26
|
+
this.baseUrl = new URL('api/agent/v1/', normalizeBaseUrl(options.baseUrl));
|
|
27
27
|
this.token = options.token ?? '';
|
|
28
28
|
this.fetchImpl = options.fetchImpl ?? fetch;
|
|
29
29
|
}
|
|
@@ -74,7 +74,7 @@ async function readResponseBody(response) {
|
|
|
74
74
|
return text;
|
|
75
75
|
}
|
|
76
76
|
}
|
|
77
|
-
function normalizeBaseUrl(baseUrl) {
|
|
77
|
+
export function normalizeBaseUrl(baseUrl) {
|
|
78
78
|
return baseUrl.endsWith('/') ? baseUrl : `${baseUrl}/`;
|
|
79
79
|
}
|
|
80
80
|
function trimLeadingSlash(path) {
|
package/dist/commands.js
CHANGED
|
@@ -5,7 +5,7 @@ import { mkdir, readFile, writeFile } from 'node:fs/promises';
|
|
|
5
5
|
import { homedir } from 'node:os';
|
|
6
6
|
import { dirname, join, resolve } from 'node:path';
|
|
7
7
|
import { fileURLToPath } from 'node:url';
|
|
8
|
-
import { AgentHttpError } from './client.js';
|
|
8
|
+
import { AgentHttpError, normalizeBaseUrl } from './client.js';
|
|
9
9
|
import { clearConfig, loadConfig, saveConfig } from './config.js';
|
|
10
10
|
import { getBoolean, getString, parseJsonOption } from './parser.js';
|
|
11
11
|
export async function runCommand(input, context) {
|
|
@@ -27,17 +27,19 @@ export async function runCommand(input, context) {
|
|
|
27
27
|
if (scope === 'research-plan')
|
|
28
28
|
return runArtifactCommand('research-plan', action, input, context.client);
|
|
29
29
|
if (scope === 'research')
|
|
30
|
-
return runResearchCommand(action, input, context
|
|
30
|
+
return runResearchCommand(action, input, context);
|
|
31
31
|
if (scope === 'draft')
|
|
32
|
-
return runDraftCommand(action, input, context
|
|
32
|
+
return runDraftCommand(action, input, context);
|
|
33
33
|
if (scope === 'workflow')
|
|
34
|
-
return runWorkflowCommand(action, input, context
|
|
34
|
+
return runWorkflowCommand(action, input, context);
|
|
35
35
|
if (scope === 'credits')
|
|
36
36
|
return runCreditsCommand(input, context.client);
|
|
37
37
|
if (scope === 'image')
|
|
38
38
|
return runResourceCommand('images', action, input, context.client);
|
|
39
39
|
if (scope === 'thread')
|
|
40
40
|
return runResourceCommand('threads', action, input, context.client);
|
|
41
|
+
if (scope === 'slideshow')
|
|
42
|
+
return runResourceCommand('slideshows', action, input, context.client);
|
|
41
43
|
if (scope === 'publish')
|
|
42
44
|
return runResourceCommand('publish', action, input, context.client);
|
|
43
45
|
if (scope === 'export')
|
|
@@ -197,7 +199,8 @@ async function runChatCommand(action, input, client) {
|
|
|
197
199
|
data: enrichChatResult(data, projectId, stage),
|
|
198
200
|
};
|
|
199
201
|
}
|
|
200
|
-
async function runWorkflowCommand(action, input,
|
|
202
|
+
async function runWorkflowCommand(action, input, context) {
|
|
203
|
+
const { client } = context;
|
|
201
204
|
const projectId = requireProjectId(input);
|
|
202
205
|
const projectPath = `projects/${encodeURIComponent(projectId)}/workflow`;
|
|
203
206
|
if (action === 'show' || action === 'status') {
|
|
@@ -208,20 +211,20 @@ async function runWorkflowCommand(action, input, client) {
|
|
|
208
211
|
const target = normalizeWorkflowWaitTarget(getString(input.values, 'target') ?? getString(input.values, 'stage')) ?? 'draft';
|
|
209
212
|
if (target === 'research') {
|
|
210
213
|
const data = await client.request({ method: 'POST', path: `projects/${encodeURIComponent(projectId)}/research/run`, body: {} });
|
|
211
|
-
return getBoolean(input.values, 'wait') ? waitForResearch(client, projectId, data) : { ok: true, data };
|
|
214
|
+
return getBoolean(input.values, 'wait') ? waitForResearch(client, projectId, data, context.baseUrl) : { ok: true, data };
|
|
212
215
|
}
|
|
213
216
|
const researchStatus = await client.request({ path: `projects/${encodeURIComponent(projectId)}/research/status` });
|
|
214
217
|
if (extractNestedString(researchStatus, ['run', 'status']) === 'paused_requires_key') {
|
|
215
218
|
const data = await client.request({ method: 'POST', path: `projects/${encodeURIComponent(projectId)}/research/run`, body: {} });
|
|
216
|
-
return getBoolean(input.values, 'wait') ? waitForWorkflowDraft(client, projectId, data) : { ok: true, data };
|
|
219
|
+
return getBoolean(input.values, 'wait') ? waitForWorkflowDraft(client, projectId, data, context.baseUrl) : { ok: true, data };
|
|
217
220
|
}
|
|
218
221
|
const draftStatus = await client.request({ path: `projects/${encodeURIComponent(projectId)}/draft/status` });
|
|
219
222
|
if (getResponseString(draftStatus, 'phase') === 'paused_requires_key') {
|
|
220
223
|
const data = await client.request({ method: 'POST', path: `projects/${encodeURIComponent(projectId)}/draft/generate`, body: {} });
|
|
221
|
-
return getBoolean(input.values, 'wait') ? waitForDraft(client, projectId, data) : { ok: true, data };
|
|
224
|
+
return getBoolean(input.values, 'wait') ? waitForDraft(client, projectId, data, context.baseUrl) : { ok: true, data };
|
|
222
225
|
}
|
|
223
226
|
const data = await client.request({ method: 'POST', path: `${projectPath}/run`, body: { target } });
|
|
224
|
-
return getBoolean(input.values, 'wait') ? waitForWorkflowDraft(client, projectId, data) : { ok: true, data };
|
|
227
|
+
return getBoolean(input.values, 'wait') ? waitForWorkflowDraft(client, projectId, data, context.baseUrl) : { ok: true, data };
|
|
225
228
|
}
|
|
226
229
|
if (action === 'advance' || action === 'run' || action === 'rewind' || action === 'approve') {
|
|
227
230
|
const body = withNamedOptions(parseJsonOption(input.values), input.values, [
|
|
@@ -247,9 +250,9 @@ async function runWorkflowCommand(action, input, client) {
|
|
|
247
250
|
?? getString(input.values, 'stage')
|
|
248
251
|
?? getResponseString(data, 'target'));
|
|
249
252
|
if (target === 'research')
|
|
250
|
-
return waitForResearch(client, projectId, data);
|
|
253
|
+
return waitForResearch(client, projectId, data, context.baseUrl);
|
|
251
254
|
if (target === 'draft')
|
|
252
|
-
return waitForWorkflowDraft(client, projectId, data);
|
|
255
|
+
return waitForWorkflowDraft(client, projectId, data, context.baseUrl);
|
|
253
256
|
}
|
|
254
257
|
return { ok: true, data };
|
|
255
258
|
}
|
|
@@ -277,14 +280,15 @@ async function runArtifactCommand(artifact, action, input, client) {
|
|
|
277
280
|
}
|
|
278
281
|
throw new Error(`Usage: coauthor ${artifact} <show|generate|save|approve> <projectId>`);
|
|
279
282
|
}
|
|
280
|
-
async function runResearchCommand(action, input,
|
|
283
|
+
async function runResearchCommand(action, input, context) {
|
|
284
|
+
const { client } = context;
|
|
281
285
|
const projectId = requireProjectId(input);
|
|
282
286
|
const basePath = `projects/${encodeURIComponent(projectId)}/research`;
|
|
283
287
|
if (action === 'run') {
|
|
284
288
|
const body = withNamedOptions(parseJsonOption(input.values), input.values, ['execution-token']);
|
|
285
289
|
const data = await client.request({ method: 'POST', path: `${basePath}/run`, body });
|
|
286
290
|
if (getBoolean(input.values, 'wait')) {
|
|
287
|
-
return waitForResearch(client, projectId, data);
|
|
291
|
+
return waitForResearch(client, projectId, data, context.baseUrl);
|
|
288
292
|
}
|
|
289
293
|
return { ok: true, data };
|
|
290
294
|
}
|
|
@@ -296,14 +300,15 @@ async function runResearchCommand(action, input, client) {
|
|
|
296
300
|
}
|
|
297
301
|
throw new Error('Usage: coauthor research <run|status|structured> <projectId>');
|
|
298
302
|
}
|
|
299
|
-
async function runDraftCommand(action, input,
|
|
303
|
+
async function runDraftCommand(action, input, context) {
|
|
304
|
+
const { client } = context;
|
|
300
305
|
const projectId = requireProjectId(input);
|
|
301
306
|
const basePath = `projects/${encodeURIComponent(projectId)}/draft`;
|
|
302
307
|
if (action === 'generate') {
|
|
303
308
|
const body = withNamedOptions(parseJsonOption(input.values), input.values, ['execution-token']);
|
|
304
309
|
const data = await client.request({ method: 'POST', path: `${basePath}/generate`, body });
|
|
305
310
|
if (getBoolean(input.values, 'wait')) {
|
|
306
|
-
return waitForDraft(client, projectId, data);
|
|
311
|
+
return waitForDraft(client, projectId, data, context.baseUrl);
|
|
307
312
|
}
|
|
308
313
|
return { ok: true, data };
|
|
309
314
|
}
|
|
@@ -336,7 +341,7 @@ async function runResourceCommand(resource, action, input, client) {
|
|
|
336
341
|
const data = await client.request({ path: `${basePath}/status` });
|
|
337
342
|
return { ok: true, data };
|
|
338
343
|
}
|
|
339
|
-
if (resource === 'threads') {
|
|
344
|
+
if (resource === 'threads' || resource === 'slideshows') {
|
|
340
345
|
const data = await client.request({ path: resourceId ? `${basePath}/${encodeURIComponent(resourceId)}` : basePath });
|
|
341
346
|
return { ok: true, data };
|
|
342
347
|
}
|
|
@@ -631,7 +636,7 @@ function openBrowser(url) {
|
|
|
631
636
|
});
|
|
632
637
|
child.unref();
|
|
633
638
|
}
|
|
634
|
-
async function waitForResearch(client, projectId, initialData) {
|
|
639
|
+
async function waitForResearch(client, projectId, initialData, baseUrl) {
|
|
635
640
|
const deadline = Date.now() + waitTimeoutMs(20 * 60_000);
|
|
636
641
|
const pollMs = waitPollMs();
|
|
637
642
|
let latest = initialData;
|
|
@@ -644,7 +649,7 @@ async function waitForResearch(client, projectId, initialData) {
|
|
|
644
649
|
if (status === 'failed')
|
|
645
650
|
throw new Error(extractNestedString(latest, ['run', 'error_message']) ?? 'Research failed');
|
|
646
651
|
if (status === 'paused_requires_key') {
|
|
647
|
-
return requiresKeyPauseResult(projectId, 'research', extractNestedString(latest, ['run', 'error_message']) ?? 'Research paused: add the required API key to continue.', latest);
|
|
652
|
+
return requiresKeyPauseResult(projectId, 'research', extractNestedString(latest, ['run', 'error_message']) ?? 'Research paused: add the required API key to continue.', latest, baseUrl);
|
|
648
653
|
}
|
|
649
654
|
const stale = researchRunningStaleResult(projectId, latest, null, initialData);
|
|
650
655
|
if (stale)
|
|
@@ -652,7 +657,7 @@ async function waitForResearch(client, projectId, initialData) {
|
|
|
652
657
|
}
|
|
653
658
|
return waitTimedOutResult(projectId, 'research', initialData, latest, null);
|
|
654
659
|
}
|
|
655
|
-
async function waitForDraft(client, projectId, initialData) {
|
|
660
|
+
async function waitForDraft(client, projectId, initialData, baseUrl) {
|
|
656
661
|
const deadline = Date.now() + waitTimeoutMs(20 * 60_000);
|
|
657
662
|
const pollMs = waitPollMs();
|
|
658
663
|
let latest = initialData;
|
|
@@ -665,13 +670,13 @@ async function waitForDraft(client, projectId, initialData) {
|
|
|
665
670
|
return { ok: true, message: 'Draft completed', data: latest };
|
|
666
671
|
}
|
|
667
672
|
if (phase === 'paused_requires_key')
|
|
668
|
-
return requiresKeyPauseResult(projectId, 'draft', getResponseString(latest, 'message') ?? 'Draft paused: add the required API key to continue.', latest);
|
|
673
|
+
return requiresKeyPauseResult(projectId, 'draft', getResponseString(latest, 'message') ?? 'Draft paused: add the required API key to continue.', latest, baseUrl);
|
|
669
674
|
if (phase === 'failed')
|
|
670
675
|
throw new Error(getResponseString(latest, 'message') ?? 'Draft generation failed');
|
|
671
676
|
}
|
|
672
677
|
return waitTimedOutResult(projectId, 'draft', initialData, null, latest);
|
|
673
678
|
}
|
|
674
|
-
async function waitForWorkflowDraft(client, projectId, initialData) {
|
|
679
|
+
async function waitForWorkflowDraft(client, projectId, initialData, baseUrl) {
|
|
675
680
|
const deadline = Date.now() + waitTimeoutMs(40 * 60_000);
|
|
676
681
|
const pollMs = waitPollMs();
|
|
677
682
|
let latestDraft = initialData;
|
|
@@ -702,7 +707,7 @@ async function waitForWorkflowDraft(client, projectId, initialData) {
|
|
|
702
707
|
workflow: initialData,
|
|
703
708
|
research_status: latestResearch,
|
|
704
709
|
draft_status: latestDraft,
|
|
705
|
-
});
|
|
710
|
+
}, baseUrl);
|
|
706
711
|
}
|
|
707
712
|
latestResearch = await client.request({ path: `projects/${encodeURIComponent(projectId)}/research/status` });
|
|
708
713
|
const researchStatus = extractNestedString(latestResearch, ['run', 'status']);
|
|
@@ -714,7 +719,7 @@ async function waitForWorkflowDraft(client, projectId, initialData) {
|
|
|
714
719
|
workflow: initialData,
|
|
715
720
|
research_status: latestResearch,
|
|
716
721
|
draft_status: latestDraft,
|
|
717
|
-
});
|
|
722
|
+
}, baseUrl);
|
|
718
723
|
}
|
|
719
724
|
const stale = researchRunningStaleResult(projectId, latestResearch, latestDraft, initialData);
|
|
720
725
|
if (stale)
|
|
@@ -901,14 +906,15 @@ function enrichResearchStatus(data) {
|
|
|
901
906
|
},
|
|
902
907
|
};
|
|
903
908
|
}
|
|
904
|
-
function requiresKeyPauseResult(projectId, target, message, data) {
|
|
909
|
+
function requiresKeyPauseResult(projectId, target, message, data, baseUrl) {
|
|
905
910
|
const resumeCommand = `coauthor workflow resume ${projectId} --target ${target} --wait --json`;
|
|
911
|
+
const settingsUrl = new URL('settings/ai', normalizeBaseUrl(baseUrl)).toString();
|
|
906
912
|
return {
|
|
907
913
|
ok: false,
|
|
908
914
|
status: 'requires_key',
|
|
909
915
|
exitCode: 2,
|
|
910
|
-
message: `${message}\nOpen AI settings:
|
|
911
|
-
settings_url:
|
|
916
|
+
message: `${message}\nOpen AI settings: ${settingsUrl}\nResume: ${resumeCommand}`,
|
|
917
|
+
settings_url: settingsUrl,
|
|
912
918
|
resume_command: resumeCommand,
|
|
913
919
|
data,
|
|
914
920
|
};
|
|
@@ -962,6 +968,8 @@ function resourceCommandName(resource) {
|
|
|
962
968
|
return 'image';
|
|
963
969
|
if (resource === 'threads')
|
|
964
970
|
return 'thread';
|
|
971
|
+
if (resource === 'slideshows')
|
|
972
|
+
return 'slideshow';
|
|
965
973
|
if (resource === 'exports')
|
|
966
974
|
return 'export';
|
|
967
975
|
if (resource === 'operations')
|
|
@@ -990,6 +998,7 @@ export function helpResult(command = []) {
|
|
|
990
998
|
' workflow run/advance supports --briefing-mode auto|strict|off and --require-brief-review',
|
|
991
999
|
' image list|status|show|generate|edit',
|
|
992
1000
|
' thread list|show|create|generate|save',
|
|
1001
|
+
' slideshow show|save',
|
|
993
1002
|
' publish thread',
|
|
994
1003
|
' export blog|clickminded',
|
|
995
1004
|
' operation list|show|status',
|
package/dist/config.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
export declare const DEFAULT_BASE_URL = "
|
|
2
|
+
export declare const DEFAULT_BASE_URL = "https://tools.clickminded.com/coauthor";
|
|
3
3
|
declare const configSchema: z.ZodObject<{
|
|
4
4
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
5
5
|
token: z.ZodOptional<z.ZodString>;
|
package/dist/config.js
CHANGED
|
@@ -2,7 +2,7 @@ import { chmod, mkdir, readFile, rm, writeFile } from 'node:fs/promises';
|
|
|
2
2
|
import { homedir } from 'node:os';
|
|
3
3
|
import { dirname, join } from 'node:path';
|
|
4
4
|
import { z } from 'zod';
|
|
5
|
-
export const DEFAULT_BASE_URL = '
|
|
5
|
+
export const DEFAULT_BASE_URL = 'https://tools.clickminded.com/coauthor';
|
|
6
6
|
const configSchema = z.object({
|
|
7
7
|
baseUrl: z.string().url().optional(),
|
|
8
8
|
token: z.string().min(1).optional(),
|
package/dist/index.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
import { realpathSync } from 'node:fs';
|
|
3
3
|
import { fileURLToPath } from 'node:url';
|
|
4
|
-
import { AgentHttpError, AgentClient } from './client.js';
|
|
5
|
-
import { resolveRuntimeConfig } from './config.js';
|
|
4
|
+
import { AgentHttpError, AgentClient, normalizeBaseUrl } from './client.js';
|
|
5
|
+
import { DEFAULT_BASE_URL, resolveRuntimeConfig } from './config.js';
|
|
6
6
|
import { helpResult, runCommand } from './commands.js';
|
|
7
7
|
import { renderError, renderResult } from './output.js';
|
|
8
8
|
import { parseCliArgs } from './parser.js';
|
|
@@ -146,7 +146,9 @@ function formatRequiresKeyResult(body, baseUrl) {
|
|
|
146
146
|
const details = envelopeError.details && typeof envelopeError.details === 'object' && !Array.isArray(envelopeError.details)
|
|
147
147
|
? envelopeError.details
|
|
148
148
|
: {};
|
|
149
|
-
const settingsUrl = typeof details.settings_url === 'string'
|
|
149
|
+
const settingsUrl = typeof details.settings_url === 'string'
|
|
150
|
+
? details.settings_url
|
|
151
|
+
: new URL('settings/ai', normalizeBaseUrl(baseUrl)).toString();
|
|
150
152
|
const resumeCommand = typeof details.resume_command === 'string' ? details.resume_command : undefined;
|
|
151
153
|
return {
|
|
152
154
|
ok: false,
|
|
@@ -181,7 +183,7 @@ function extractEnvelopeError(body) {
|
|
|
181
183
|
function resolveBaseUrlFromArgv(argv) {
|
|
182
184
|
const index = argv.indexOf('--base-url');
|
|
183
185
|
const value = index >= 0 ? argv[index + 1] : undefined;
|
|
184
|
-
return value || process.env.COAUTHOR_BASE_URL ||
|
|
186
|
+
return value || process.env.COAUTHOR_BASE_URL || DEFAULT_BASE_URL;
|
|
185
187
|
}
|
|
186
188
|
function isCliEntrypoint() {
|
|
187
189
|
const argvPath = process.argv[1];
|
package/dist/parser.js
CHANGED
|
@@ -108,7 +108,7 @@ function commandLength(positionals) {
|
|
|
108
108
|
return second ? 2 : 1;
|
|
109
109
|
if (first === 'credits')
|
|
110
110
|
return 1;
|
|
111
|
-
if (['contract', 'outline', 'research-plan', 'research', 'draft', 'image', 'thread', 'publish', 'export', 'operation'].includes(first ?? ''))
|
|
111
|
+
if (['contract', 'outline', 'research-plan', 'research', 'draft', 'image', 'thread', 'slideshow', 'publish', 'export', 'operation'].includes(first ?? ''))
|
|
112
112
|
return second ? 2 : 1;
|
|
113
113
|
return 1;
|
|
114
114
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@clickminded/coauthor-cli",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.12",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"bin": {
|
|
6
6
|
"coauthor": "dist/index.js",
|
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
},
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
11
|
-
"url": "git+https://github.com/
|
|
12
|
-
"directory": "packages/cli"
|
|
11
|
+
"url": "git+https://github.com/ClickMinded/newsletter-generator.git",
|
|
12
|
+
"directory": "coauthor/packages/cli"
|
|
13
13
|
},
|
|
14
14
|
"exports": {
|
|
15
15
|
".": {
|
package/skills/agents/SKILL.md
CHANGED
|
@@ -9,8 +9,8 @@ This skill guides agent use of the CoAuthor CLI.
|
|
|
9
9
|
|
|
10
10
|
- Prefer `coauthor` CLI commands for CoAuthor project and workflow work.
|
|
11
11
|
- Do not drive browser routes, hand-written `curl`, or direct database edits when a CLI command covers the task.
|
|
12
|
-
- Use the
|
|
13
|
-
- For local development only, pass an explicit one-off override such as `--base-url http://localhost:3000` or `COAUTHOR_BASE_URL=http://localhost:3000
|
|
12
|
+
- Use the built-in production base URL (`https://tools.clickminded.com/coauthor`) by default. Do not point the CLI at `localhost` or start a local dev server unless the user explicitly asks to test local changes.
|
|
13
|
+
- For local development only, pass an explicit one-off override such as `--base-url http://localhost:3000/coauthor` or `COAUTHOR_BASE_URL=http://localhost:3000/coauthor` for mounted dev, or `--base-url http://localhost:3000` for a root-mounted app.
|
|
14
14
|
- Use `--json` for machine-readable output and parse fields from that output.
|
|
15
15
|
- Use `--wait` for commands that start asynchronous work when the user expects the operation to finish.
|
|
16
16
|
- Let the default bounded briefing review run before outline/draft generation. Use `--briefing-mode strict` when the user explicitly wants a stronger brief gate, and answer or relay `data.clarification_questions` if the CLI returns `status: "needs_clarification"`.
|
package/skills/claude/SKILL.md
CHANGED
|
@@ -9,8 +9,8 @@ This skill guides agent use of the CoAuthor CLI.
|
|
|
9
9
|
|
|
10
10
|
- Prefer `coauthor` CLI commands for CoAuthor project and workflow work.
|
|
11
11
|
- Do not drive browser routes, hand-written `curl`, or direct database edits when a CLI command covers the task.
|
|
12
|
-
- Use the
|
|
13
|
-
- For local development only, pass an explicit one-off override such as `--base-url http://localhost:3000` or `COAUTHOR_BASE_URL=http://localhost:3000
|
|
12
|
+
- Use the built-in production base URL (`https://tools.clickminded.com/coauthor`) by default. Do not point the CLI at `localhost` or start a local dev server unless the user explicitly asks to test local changes.
|
|
13
|
+
- For local development only, pass an explicit one-off override such as `--base-url http://localhost:3000/coauthor` or `COAUTHOR_BASE_URL=http://localhost:3000/coauthor` for mounted dev, or `--base-url http://localhost:3000` for a root-mounted app.
|
|
14
14
|
- Use `--json` for machine-readable output and parse fields from that output.
|
|
15
15
|
- Use `--wait` for commands that start asynchronous work when the user expects the operation to finish.
|
|
16
16
|
- Let the default bounded briefing review run before outline/draft generation. Use `--briefing-mode strict` when the user explicitly wants a stronger brief gate, and answer or relay `data.clarification_questions` if the CLI returns `status: "needs_clarification"`.
|
package/skills/codex/SKILL.md
CHANGED
|
@@ -9,8 +9,8 @@ This skill guides agent use of the CoAuthor CLI.
|
|
|
9
9
|
|
|
10
10
|
- Prefer `coauthor` CLI commands for CoAuthor project and workflow work.
|
|
11
11
|
- Do not drive browser routes, hand-written `curl`, or direct database edits when a CLI command covers the task.
|
|
12
|
-
- Use the
|
|
13
|
-
- For local development only, pass an explicit one-off override such as `--base-url http://localhost:3000` or `COAUTHOR_BASE_URL=http://localhost:3000
|
|
12
|
+
- Use the built-in production base URL (`https://tools.clickminded.com/coauthor`) by default. Do not point the CLI at `localhost` or start a local dev server unless the user explicitly asks to test local changes.
|
|
13
|
+
- For local development only, pass an explicit one-off override such as `--base-url http://localhost:3000/coauthor` or `COAUTHOR_BASE_URL=http://localhost:3000/coauthor` for mounted dev, or `--base-url http://localhost:3000` for a root-mounted app.
|
|
14
14
|
- Use `--json` for machine-readable output and parse fields from that output.
|
|
15
15
|
- Use `--wait` for commands that start asynchronous work when the user expects the operation to finish.
|
|
16
16
|
- Let the default bounded briefing review run before outline/draft generation. Use `--briefing-mode strict` when the user explicitly wants a stronger brief gate, and answer or relay `data.clarification_questions` if the CLI returns `status: "needs_clarification"`.
|
|
@@ -6,8 +6,8 @@ alwaysApply: true
|
|
|
6
6
|
# CoAuthor CLI
|
|
7
7
|
|
|
8
8
|
- Prefer the `coauthor` CLI for CoAuthor project/workflow operations instead of browser routes, hand-written `curl`, or direct database access.
|
|
9
|
-
- Use the
|
|
10
|
-
- For local development only, pass an explicit one-off override such as `--base-url http://localhost:3000` or `COAUTHOR_BASE_URL=http://localhost:3000
|
|
9
|
+
- Use the built-in production base URL (`https://tools.clickminded.com/coauthor`) by default. Do not point the CLI at `localhost` or start a local dev server unless the user explicitly asks to test local changes.
|
|
10
|
+
- For local development only, pass an explicit one-off override such as `--base-url http://localhost:3000/coauthor` or `COAUTHOR_BASE_URL=http://localhost:3000/coauthor` for mounted dev, or `--base-url http://localhost:3000` for a root-mounted app.
|
|
11
11
|
- Use `--json` for agent-readable command output.
|
|
12
12
|
- Use `--wait` when starting asynchronous work and the user expects a completed result.
|
|
13
13
|
- Let the default bounded briefing review run before outline/draft generation. Use `--briefing-mode strict` for a stronger brief gate, and answer or relay `data.clarification_questions` if the CLI returns `status: "needs_clarification"`.
|