@workscribe/cli 1.1.2 → 1.2.0
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 -2
- package/dist/index.js +400 -77
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -27,6 +27,16 @@ A shell hook captures every command you run. At the end of the day, `workscribe
|
|
|
27
27
|
shell hook → capture → SQLite → session grouper → AI provider → markdown
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
+
## Requirements
|
|
31
|
+
|
|
32
|
+
| Dependency | Version | Notes |
|
|
33
|
+
|---|---|---|
|
|
34
|
+
| Node.js | **22 or later** | Uses the built-in `node:sqlite` module — not available in Node 20 or earlier |
|
|
35
|
+
| Shell | zsh or bash | Hook is appended to `~/.zshrc` or `~/.bashrc` by `workscribe init` |
|
|
36
|
+
| OS | macOS or Linux | Windows is not supported |
|
|
37
|
+
|
|
38
|
+
> Check your version: `node --version`
|
|
39
|
+
|
|
30
40
|
## Install
|
|
31
41
|
|
|
32
42
|
```bash
|
|
@@ -37,8 +47,6 @@ source ~/.zshrc # or restart your terminal
|
|
|
37
47
|
|
|
38
48
|
`workscribe init` walks you through choosing an AI provider and installs the shell hook. From that point, capture is automatic.
|
|
39
49
|
|
|
40
|
-
**Requirements:** Node.js 22+, macOS or Linux (zsh or bash)
|
|
41
|
-
|
|
42
50
|
## AI providers
|
|
43
51
|
|
|
44
52
|
Workscribe works with any of these — switch at any time via config:
|
|
@@ -67,6 +75,9 @@ workscribe config set ai.apiKey <your-key>
|
|
|
67
75
|
| `workscribe events` | List captured events |
|
|
68
76
|
| `workscribe export` | Save today's summary as a markdown file |
|
|
69
77
|
| `workscribe status` | Check capture is active and show event counts |
|
|
78
|
+
| `workscribe undo` | Remove the last captured event |
|
|
79
|
+
| `workscribe undo -n 5` | Remove the last 5 captured events |
|
|
80
|
+
| `workscribe undo --dry-run` | Preview what would be removed without deleting |
|
|
70
81
|
| `workscribe pause` | Pause capture temporarily |
|
|
71
82
|
| `workscribe resume` | Resume capture after a pause |
|
|
72
83
|
| `workscribe config` | View current configuration |
|
|
@@ -86,6 +97,14 @@ workscribe config set ai.apiKey <your-key>
|
|
|
86
97
|
workscribe config set session.idleTimeout 20 # minutes before a new session starts (default: 30)
|
|
87
98
|
workscribe config set ai.model gpt-4o # override the default model for your provider
|
|
88
99
|
workscribe config set redact.extra "MY_PATTERN" # add a custom redaction regex
|
|
100
|
+
|
|
101
|
+
# Override the display name for a local clone whose folder name differs from the repo
|
|
102
|
+
workscribe config set projects./Users/me/sandbox/myrepo actual-repo-name
|
|
103
|
+
|
|
104
|
+
# Post summaries to Slack or a custom webhook
|
|
105
|
+
workscribe config set integrations.slackWebhook https://hooks.slack.com/services/...
|
|
106
|
+
workscribe summary --slack
|
|
107
|
+
workscribe summary --webhook https://custom.endpoint/hook
|
|
89
108
|
```
|
|
90
109
|
|
|
91
110
|
Config is stored at `~/.workscribe/config.json`.
|