@quillmeetings/cli 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 +79 -7
- package/SKILL.md +114 -0
- package/TRADEMARKS.md +5 -0
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -36,7 +36,7 @@ Or run without linking:
|
|
|
36
36
|
node bin/quill.js --help
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
## Prerequisite: Quill MCP Bridge
|
|
39
|
+
## Prerequisite: Enable Quill MCP Bridge (In Desktop App)
|
|
40
40
|
|
|
41
41
|
The CLI talks to Quill through a local MCP bridge that ships with the Quill desktop app. Install Quill desktop, sign in, and enable the MCP server in Quill Settings -> MCP / Integrations.
|
|
42
42
|
|
|
@@ -204,6 +204,76 @@ Interactive browsing is disabled in agent mode. `quill browse --json` returns a
|
|
|
204
204
|
}
|
|
205
205
|
```
|
|
206
206
|
|
|
207
|
+
## LLM Agent Usage
|
|
208
|
+
|
|
209
|
+
LLM agents should use `--json` for deterministic output and should avoid interactive commands.
|
|
210
|
+
|
|
211
|
+
Recommended preflight:
|
|
212
|
+
|
|
213
|
+
```bash
|
|
214
|
+
quill doctor --json
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
Common agent-safe commands:
|
|
218
|
+
|
|
219
|
+
```bash
|
|
220
|
+
quill meetings list --json --limit 10
|
|
221
|
+
quill meetings list --json --today
|
|
222
|
+
quill search "pricing risk" --json --limit 5
|
|
223
|
+
quill meetings view <meeting-id> --json
|
|
224
|
+
quill notes <meeting-id> --json
|
|
225
|
+
quill transcript <meeting-id> --json --full
|
|
226
|
+
quill actions <meeting-id> --json --instruction "Group by owner"
|
|
227
|
+
quill followup <meeting-id> --json --instruction "Tone: concise and ready to send"
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
Agent rules:
|
|
231
|
+
|
|
232
|
+
- Always pass `--json` when another program will parse the result.
|
|
233
|
+
- Do not call `quill browse`; it requires a real terminal.
|
|
234
|
+
- If setup fails, run `quill doctor --json` and follow the first remediation.
|
|
235
|
+
- Use `--fields` to reduce context for list commands.
|
|
236
|
+
- Use `--full` only when the complete transcript or note body is needed.
|
|
237
|
+
- Use `quill mcp tools --json` and `quill mcp schema <tool> --json` only when curated commands do not cover the task.
|
|
238
|
+
|
|
239
|
+
See [SKILL.md](SKILL.md) for a compact agent instruction file that can be copied into agent systems such as local agent runners, Claude Code, or Codex.
|
|
240
|
+
|
|
241
|
+
## Shell Automation
|
|
242
|
+
|
|
243
|
+
Use `--json` with `jq` for scripts:
|
|
244
|
+
|
|
245
|
+
```bash
|
|
246
|
+
quill meetings list --json --limit 5 \
|
|
247
|
+
| jq -r '.result.result.meetings[]? | [.id, .title, .date] | @tsv'
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
Fetch notes for today's meetings:
|
|
251
|
+
|
|
252
|
+
```bash
|
|
253
|
+
quill meetings list --json --today \
|
|
254
|
+
| jq -r '.result.result.meetings[]?.id' \
|
|
255
|
+
| while read -r id; do
|
|
256
|
+
quill notes "$id" --json
|
|
257
|
+
done
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
Search meetings and print IDs:
|
|
261
|
+
|
|
262
|
+
```bash
|
|
263
|
+
quill search "customer renewal" --json --limit 10 \
|
|
264
|
+
| jq -r '.result.result.meetings[]?.id'
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
Fail fast in CI or cron:
|
|
268
|
+
|
|
269
|
+
```bash
|
|
270
|
+
set -euo pipefail
|
|
271
|
+
quill doctor --json >/dev/null
|
|
272
|
+
quill meetings list --json --limit 1 >/dev/null
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
For repeatable scripts, prefer command flags over persistent config. Precedence is: command flags > environment variables > config file > built-in defaults.
|
|
276
|
+
|
|
207
277
|
## Output
|
|
208
278
|
|
|
209
279
|
Default output is human-readable. Lists render as tables in normal CLI use. Use `--format toon` for compact, YAML-like output that's cheap on LLM context, or `--json` for machine consumers.
|
|
@@ -331,7 +401,7 @@ node bin/quill.js mcp tools
|
|
|
331
401
|
|
|
332
402
|
The test suite uses Node's built-in `node:test` and `node:assert` — no external test framework. Files live in `test/` and cover the highest-leverage code:
|
|
333
403
|
|
|
334
|
-
- `test/mcp-client.test.js` —
|
|
404
|
+
- `test/mcp-client.test.js` — MCP result parsing and client error handling.
|
|
335
405
|
- `test/tool-router.test.js` — fuzzy alias matching in `findTool` and key remapping in `buildArgs`.
|
|
336
406
|
- `test/format.test.js` — `shapeForOutput`, `toHuman`, `toToon`, `truncateText`, etc.
|
|
337
407
|
|
|
@@ -355,13 +425,15 @@ src/cli.js command parsing, routing, help, and MCP command wiring
|
|
|
355
425
|
src/browser.js Ink-powered interactive meeting browser
|
|
356
426
|
src/config.js JSON config defaults, path resolution, get/set helpers
|
|
357
427
|
src/doctor.js First-run diagnostics for Quill desktop and MCP setup
|
|
358
|
-
src/mcp-client.js Quill MCP bridge client and
|
|
428
|
+
src/mcp-client.js Quill MCP bridge client and result parsing
|
|
359
429
|
src/format.js TOON/JSON/human output shaping, truncation, field selection
|
|
360
430
|
src/tool-router.js curated command to MCP tool mapping
|
|
361
431
|
```
|
|
362
432
|
|
|
363
|
-
|
|
433
|
+
## License
|
|
434
|
+
|
|
435
|
+
MIT. See [LICENSE](LICENSE).
|
|
436
|
+
|
|
437
|
+
## Trademarks
|
|
364
438
|
|
|
365
|
-
|
|
366
|
-
- Quill tool results often contain XML-like `ToolResponse` text. The CLI parses the known Quill response shapes for compact display and keeps raw MCP access available for debugging.
|
|
367
|
-
- MCP stdout buffers are capped by `mcp.max_buffer_bytes` to avoid unbounded memory growth on malformed or very large responses.
|
|
439
|
+
Quill and Quill Meetings are trademarks of Quill Meetings. See [TRADEMARKS.md](TRADEMARKS.md).
|
package/SKILL.md
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Quill CLI Agent Skill
|
|
2
|
+
|
|
3
|
+
Use Quill CLI to inspect and automate Quill Meetings through the local Quill desktop MCP bridge.
|
|
4
|
+
|
|
5
|
+
## Preconditions
|
|
6
|
+
|
|
7
|
+
- Quill desktop must be installed and signed in.
|
|
8
|
+
- The MCP server must be enabled in Quill Settings -> MCP / Integrations.
|
|
9
|
+
- Run this first when setup state is unknown:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
quill doctor --json
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
If `quill` is not installed globally, use:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx @quillmeetings/cli doctor --json
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Agent Rules
|
|
22
|
+
|
|
23
|
+
- Use `--json` for every command whose output will be parsed.
|
|
24
|
+
- Do not use `quill browse`; it is interactive.
|
|
25
|
+
- Prefer curated commands before raw MCP calls.
|
|
26
|
+
- Use `--fields` and `--limit` to keep output small.
|
|
27
|
+
- Use `--full` only when complete notes or transcripts are required.
|
|
28
|
+
- If a command returns a setup or bridge error, run `quill doctor --json` and follow the first remediation.
|
|
29
|
+
- Do not print or store transcript/notes output outside the user's requested destination.
|
|
30
|
+
|
|
31
|
+
## Common Commands
|
|
32
|
+
|
|
33
|
+
List recent meetings:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
quill meetings list --json --limit 10
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
List today's meetings:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
quill meetings list --json --today
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Search meetings:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
quill search "roadmap risk" --json --limit 5
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
View a meeting:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
quill meetings view <meeting-id> --json
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Read notes:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
quill notes <meeting-id> --json
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Read a full transcript:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
quill transcript <meeting-id> --json --full
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Generate action items:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
quill actions <meeting-id> --json --instruction "Group by owner"
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Generate a follow-up:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
quill followup <meeting-id> --json --instruction "Tone: concise and ready to send"
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Raw MCP Escape Hatch
|
|
82
|
+
|
|
83
|
+
Use raw MCP only when curated commands do not cover the task:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
quill mcp tools --json
|
|
87
|
+
quill mcp schema <tool> --json
|
|
88
|
+
quill mcp call <tool> --input '{"key":"value"}' --json
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Shell Automation
|
|
92
|
+
|
|
93
|
+
Extract meeting IDs:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
quill meetings list --json --limit 10 | jq -r '.result.result.meetings[]?.id'
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Loop over today's meetings:
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
quill meetings list --json --today \
|
|
103
|
+
| jq -r '.result.result.meetings[]?.id' \
|
|
104
|
+
| while read -r id; do
|
|
105
|
+
quill notes "$id" --json
|
|
106
|
+
done
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Run a setup preflight in scripts:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
set -euo pipefail
|
|
113
|
+
quill doctor --json >/dev/null
|
|
114
|
+
```
|
package/TRADEMARKS.md
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Trademarks
|
|
2
|
+
|
|
3
|
+
Quill and Quill Meetings are trademarks of Quill Meetings.
|
|
4
|
+
|
|
5
|
+
This project is licensed under the MIT License, but that license does not grant permission to use Quill names, logos, or brand assets in a way that suggests endorsement, sponsorship, or affiliation beyond this CLI project.
|
package/package.json
CHANGED
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quillmeetings/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Human-friendly and agent-ready CLI for Quill Meetings backed by the Quill MCP server.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"files": [
|
|
7
7
|
"bin",
|
|
8
8
|
"src",
|
|
9
9
|
"README.md",
|
|
10
|
+
"SKILL.md",
|
|
11
|
+
"TRADEMARKS.md",
|
|
10
12
|
"LICENSE"
|
|
11
13
|
],
|
|
12
14
|
"bin": {
|