@workscribe/cli 1.15.6 → 2.0.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 +24 -21
- package/dist/index.js +3819 -2350
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
- package/skills/workscribe/SKILL.md +61 -0
- package/skills/workscribe/references/json-contract.md +43 -0
- package/skills/workscribe/references/summary-format.md +36 -0
package/README.md
CHANGED
|
@@ -12,23 +12,30 @@
|
|
|
12
12
|
$ workscribe summary
|
|
13
13
|
|
|
14
14
|
## api-service (feature/auth) — 2h 15m
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
15
|
+
- Committed: add JWT validation middleware
|
|
16
|
+
- Committed: fix token expiry check
|
|
17
|
+
- Resolved failing tests (9 runs, now passing)
|
|
18
|
+
- Added dependencies: bcrypt, jsonwebtoken
|
|
19
|
+
- Pushed to origin/feature/auth
|
|
18
20
|
|
|
19
21
|
## infrastructure — 45m
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
+
- Note: staging was flaky after the compose upgrade
|
|
23
|
+
- Builds passing (2 runs)
|
|
22
24
|
```
|
|
23
25
|
|
|
24
|
-
|
|
26
|
+
Want prose instead? Ask your coding agent to *"summarize my work today"* — see [Summaries](#summaries).
|
|
27
|
+
|
|
28
|
+
**[Full documentation →](https://workscribe.mintlify.site)** — commands, configuration, summaries, troubleshooting. This README covers getting started; everything else lives there and is kept current as the product changes.
|
|
25
29
|
|
|
26
30
|
## How it works
|
|
27
31
|
|
|
28
|
-
A shell hook captures every command you run. At the end of the day, `workscribe summary` groups your activity into work sessions and
|
|
32
|
+
A shell hook captures every command you run. At the end of the day, `workscribe summary` groups your activity into work sessions and turns them into a summary with its offline template engine — no AI provider, no API key, nothing sent anywhere.
|
|
33
|
+
|
|
34
|
+
For AI-written prose, ask the coding agent you already use (Claude Code, Codex, GitHub Copilot or Cursor) to *"summarize my work today"*. The Workscribe agent skill reads your sessions and writes the summary — install it with `workscribe skill install`.
|
|
29
35
|
|
|
30
36
|
```
|
|
31
|
-
shell hook → capture → SQLite → session grouper →
|
|
37
|
+
shell hook → capture → SQLite → session grouper → template engine → markdown
|
|
38
|
+
↘ agent skill (your coding agent) → prose summary
|
|
32
39
|
```
|
|
33
40
|
|
|
34
41
|
## Requirements
|
|
@@ -51,7 +58,7 @@ source ~/.zshrc # or restart your terminal
|
|
|
51
58
|
|
|
52
59
|
> Use the global install flag for your package manager — e.g. `npm install -g`, `yarn global add`, `pnpm add -g`, or `bun add -g`.
|
|
53
60
|
|
|
54
|
-
`workscribe init`
|
|
61
|
+
`workscribe init` installs the shell hook, offers to install a Claude Code session capture hook if Claude Code is detected, and offers to install the Workscribe skill into the coding agents it finds. Safe to re-run — updates outdated hooks and skips steps already complete.
|
|
55
62
|
|
|
56
63
|
## Also capturing in your editor?
|
|
57
64
|
|
|
@@ -62,8 +69,8 @@ The [Workscribe VS Code extension](https://marketplace.visualstudio.com/items?it
|
|
|
62
69
|
If the CLI is still installed:
|
|
63
70
|
|
|
64
71
|
```bash
|
|
65
|
-
workscribe uninstall # removes shell hooks, optionally deletes local data
|
|
66
|
-
npm uninstall -g @workscribe/cli
|
|
72
|
+
workscribe uninstall # removes shell hooks and the agent skill, optionally deletes local data
|
|
73
|
+
npm uninstall -g @workscribe/cli # run after — npm doesn't run Workscribe's cleanup itself
|
|
67
74
|
```
|
|
68
75
|
|
|
69
76
|
If you've already removed the binary and still see `_workscribe_precmd` errors in your terminal, remove the hook block manually:
|
|
@@ -72,16 +79,13 @@ If you've already removed the binary and still see `_workscribe_precmd` errors i
|
|
|
72
79
|
2. Delete everything between `# workscribe:hook:start` and `# workscribe:hook:end` (inclusive)
|
|
73
80
|
3. Run `source ~/.zshrc` or restart your terminal
|
|
74
81
|
|
|
75
|
-
##
|
|
82
|
+
## Summaries
|
|
76
83
|
|
|
77
|
-
|
|
84
|
+
`workscribe summary`, `week` and `export` use a built-in template engine: deterministic, instant and fully offline. There's nothing to configure.
|
|
78
85
|
|
|
79
|
-
|
|
80
|
-
workscribe config set ai.provider anthropic
|
|
81
|
-
workscribe config set ai.apiKey <your-key>
|
|
82
|
-
```
|
|
86
|
+
For AI-written summaries, use the coding agent you already have. `workscribe skill install` adds the Workscribe skill to Claude Code, Codex, GitHub Copilot and Cursor; then ask the agent to *"summarize my work today"* (or type `/workscribe` in Claude Code). Summaries the agent writes are saved, so `workscribe summary` and the VS Code status bar show them too.
|
|
83
87
|
|
|
84
|
-
**[
|
|
88
|
+
**[How summaries work →](https://workscribe.mintlify.site/summaries)** · **Upgrading from 1.x?** AI providers were removed in 2.0 — see the **[migration guide →](https://workscribe.mintlify.site/migrating-to-2)**
|
|
85
89
|
|
|
86
90
|
## Commands
|
|
87
91
|
|
|
@@ -100,8 +104,8 @@ A few of the most common:
|
|
|
100
104
|
|
|
101
105
|
- All captured activity data is stored locally on your machine — nothing is written anywhere else
|
|
102
106
|
- Credentials are redacted before any event is written to disk (tokens, API keys, passwords, JWTs)
|
|
103
|
-
-
|
|
104
|
-
-
|
|
107
|
+
- `workscribe summary`, `week` and `export` never send your activity anywhere — the template engine runs entirely on your machine
|
|
108
|
+
- The agent skill is the one exception, and only when you ask your coding agent for a summary: the agent sends the session data it reads to its own model provider
|
|
105
109
|
- Separately, Workscribe sends an anonymous install ping (a random ID, CLI version, OS platform, Node version — no activity data, ever), disclosed during `workscribe init`. Opt out anytime: `workscribe config set telemetry.enabled false`
|
|
106
110
|
|
|
107
111
|
**[Full privacy & security details →](https://workscribe.mintlify.site/privacy)**
|
|
@@ -109,7 +113,6 @@ A few of the most common:
|
|
|
109
113
|
## Configuration
|
|
110
114
|
|
|
111
115
|
```bash
|
|
112
|
-
workscribe config set ai.provider anthropic
|
|
113
116
|
workscribe config set session.idleTimeout 20
|
|
114
117
|
workscribe config set integrations.slackWebhook https://hooks.slack.com/services/...
|
|
115
118
|
workscribe summary --slack
|