@workscribe/cli 1.15.4 → 1.15.6

package/README.md

@@ -1,8 +1,12 @@
 # Workscribe
 
+[![npm version](https://img.shields.io/npm/v/@workscribe/cli)](https://www.npmjs.com/package/@workscribe/cli)
+[![npm downloads](https://img.shields.io/npm/dw/@workscribe/cli)](https://www.npmjs.com/package/@workscribe/cli)
+[![license](https://img.shields.io/npm/l/@workscribe/cli)](https://www.npmjs.com/package/@workscribe/cli)
+
 > Your work, automatically documented.
 
-Workscribe is a CLI tool that passively captures your terminal activity and transforms it into readable daily work summaries — without you having to write anything.
+[Workscribe](https://workscribe.co) is a CLI tool that passively captures your terminal activity and transforms it into readable daily work summaries — without you having to write anything.
 
 ```
 $ workscribe summary
@@ -17,6 +21,8 @@ $ workscribe summary
 - Investigated and resolved Docker networking issue in compose setup
 ```
 
+**[Full documentation →](https://workscribe.mintlify.site)** — commands, configuration, AI providers, troubleshooting. This README covers getting started; everything else lives there and is kept current as the product changes.
+
 ## How it works
 
 A shell hook captures every command you run. At the end of the day, `workscribe summary` groups your activity into work sessions and sends structured event data (never raw commands) to your configured AI provider, which returns a standup-ready narrative.
@@ -47,12 +53,16 @@ source ~/.zshrc   # or restart your terminal
 
 `workscribe init` walks you through choosing an AI provider, installs the shell hook, and offers to install a Claude Code session capture hook if Claude Code is detected. Safe to re-run — updates outdated hooks and skips steps already complete.
 
+## Also capturing in your editor?
+
+The [Workscribe VS Code extension](https://marketplace.visualstudio.com/items?itemName=workscribe.workscribe) feeds file saves, debug sessions, and test/build runs into the same summary — activity pure terminal capture misses entirely. It also adds a status bar item that surfaces the last summary for a file you haven't touched in 24+ hours. Uses this CLI under the hood; no separate setup beyond installing it.
+
 ## Uninstalling
 
 If the CLI is still installed:
 
 ```bash
-workscribe uninstall        # removes shell hooks, optionally deletes ~/.workscribe/
+workscribe uninstall        # removes shell hooks, optionally deletes local data
 npm uninstall -g @workscribe/cli
 ```
 
@@ -64,128 +74,48 @@ If you've already removed the binary and still see `_workscribe_precmd` errors i
 
 ## AI providers
 
-Workscribe works with any of these — switch at any time via config:
-
-| Provider | Config value | Requires |
-|---|---|---|
-| Anthropic (Claude) | `anthropic` | API key |
-| OpenAI | `openai` | API key |
-| Ollama (local) | `ollama` | Ollama running locally — free, offline |
-| OpenAI-compatible | `openai-compatible` | API key + base URL (Groq, Together, Mistral…) |
+Anthropic, OpenAI, Gemini, Groq, Ollama (fully offline), or any OpenAI-compatible endpoint.
 
 ```bash
-workscribe config set ai.provider ollama      # switch to local
-workscribe config set ai.provider anthropic   # switch to Anthropic
+workscribe config set ai.provider anthropic
 workscribe config set ai.apiKey <your-key>
 ```
 
+**[Provider setup, defaults, and model overrides →](https://workscribe.mintlify.site/providers)**
+
 ## Commands
 
+A few of the most common:
+
 | Command | Description |
 |---|---|
-| `workscribe init` | Set up Workscribe, install shell hooks, configure AI provider |
-| `workscribe uninstall` | Remove shell hooks and optionally delete all local data |
 | `workscribe summary` | Generate today's work summary |
-| `workscribe summary --date 2026-05-20` | Summary for a specific date |
-| `workscribe summary --week` | Summary for the current week |
-| `workscribe summary --fresh` | Bypass cache and regenerate |
-| `workscribe summary --verbose` | Show all captured events (including those excluded from AI) |
-| `workscribe summary --slack` | Post summary to configured Slack channel |
-| `workscribe summary --webhook <url>` | Post summary to a custom webhook URL |
-| `workscribe sessions` | List detected work sessions for today |
-| `workscribe sessions --date 2026-05-20` | Sessions for a specific date |
-| `workscribe events` | List captured events for today |
-| `workscribe events --date 2026-05-20` | Events for a specific date |
-| `workscribe events --limit 20` | Show only the most recent N events |
-| `workscribe export` | Save today's summary as a markdown file |
-| `workscribe export --date 2026-05-20` | Export summary for a specific date |
-| `workscribe export --output <path>` | Write to a custom file path |
+| `workscribe week` | Generate this week's digest |
 | `workscribe status` | Check capture is active and show event counts |
-| `workscribe undo` | Remove the last captured event |
-| `workscribe undo -n 5` | Remove the last 5 captured events |
-| `workscribe undo --dry-run` | Preview what would be removed without deleting |
-| `workscribe clear` | Delete all captured events for today |
-| `workscribe clear --date 2026-05-20` | Delete all events for a specific date |
-| `workscribe clear --dry-run` | Preview what would be cleared without deleting |
-| `workscribe clear --yes` | Skip the confirmation prompt |
-| `workscribe pause` | Pause capture temporarily |
-| `workscribe resume` | Resume capture after a pause |
-| `workscribe config` | View current configuration |
-| `workscribe config get KEY` | Print a single config value |
-| `workscribe config set KEY VALUE` | Update a config value |
+| `workscribe config` | View or update configuration |
+
+**[Full command reference →](https://workscribe.mintlify.site/commands)** — every command and every flag.
 
 ## Privacy
 
-- All captured data is stored locally in `~/.workscribe/` — nothing is written anywhere else
+- All captured activity data is stored locally on your machine — nothing is written anywhere else
 - Credentials are redacted before any event is written to disk (tokens, API keys, passwords, JWTs)
-- Nothing is sent to any remote server except your configured AI provider, only when you run `workscribe summary`
-- The AI provider receives structured event categories (e.g. `test_run`, `code_commit`) — never raw commands, file contents, or file paths
-- Use Ollama to keep everything fully on-device with zero external data transmission
+- Your captured activity (commands, sessions) is never sent anywhere except your configured AI provider, and only when you run `workscribe summary`
+- Use Ollama to keep that data fully on-device with zero external transmission
+- 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`
+
+**[Full privacy & security details →](https://workscribe.mintlify.site/privacy)**
 
 ## Configuration
 
 ```bash
-workscribe config set session.idleTimeout 20       # minutes before a new session starts (default: 30)
-workscribe config set ai.model gpt-4o              # override the default model for your provider
-workscribe config set redact.extra "MY_PATTERN"    # add a custom redaction regex
-workscribe config set summary.format json          # output summary as JSON instead of markdown
-workscribe config set capture.ignore "mycommand"   # suppress a command from being captured
-
-# Override the display name for a local clone whose folder name differs from the repo
-workscribe config set projects./Users/me/sandbox/myrepo actual-repo-name
-
-# Post summaries to Slack or a custom webhook
+workscribe config set ai.provider anthropic
+workscribe config set session.idleTimeout 20
 workscribe config set integrations.slackWebhook https://hooks.slack.com/services/...
-workscribe config set integrations.webhook https://custom.endpoint/hook   # persistent default webhook
 workscribe summary --slack
-workscribe summary --webhook https://custom.endpoint/hook                 # one-off override
 ```
 
-| Config key | Default | Description |
-|---|---|---|
-| `ai.provider` | — | AI provider: `anthropic`, `openai`, `ollama`, `openai-compatible` |
-| `ai.apiKey` | — | API key for the configured provider |
-| `ai.model` | provider default | Model name override |
-| `ai.baseUrl` | — | Base URL for `openai-compatible` providers |
-| `session.idleTimeout` | `30` | Minutes of inactivity before a new session starts |
-| `git.qualifyRepoName` | `false` | Use `owner/repo` instead of bare `repo` for `repo_name` — helpful if you work across repos whose bare names collide (e.g. an org that names its repos after the tool each one targets) |
-| `capture.ignore` | common shell builtins | Commands to exclude from capture |
-| `capture.aiTools` | `true` | Set to `false` to disable all AI session capture |
-| `capture.includeAiderPrompt` | `true` | Set to `false` to skip reading Aider's history file for prompt context |
-| `redact.extra` | `[]` | Additional regex patterns to redact from captured commands |
-| `summary.format` | `markdown` | Output format: `markdown` or `json` |
-| `summary.includeCategories` | `[]` | Event categories to re-include in the AI prompt (e.g. `["linting"]`) |
-| `integrations.slackWebhook` | — | Slack incoming webhook URL |
-| `integrations.webhook` | — | Default webhook URL for `--webhook` |
-| `projects.<path>` | — | Display name override for a repo by absolute path |
-
-## Slack integration
-
-Post your daily or weekly summary directly to a Slack channel:
-
-```bash
-workscribe summary --slack
-workscribe summary --week --slack
-```
-
-**Setup:**
-
-1. Go to [api.slack.com/apps](https://api.slack.com/apps) → **Create New App** → **From scratch**
-2. Name your app, select your workspace, and click **Create App**
-3. In the left sidebar under **Features**, click **Incoming Webhooks**
-4. Toggle **Activate Incoming Webhooks** to On
-5. Click **Add New Webhook to Workspace**, choose a channel, and click **Allow**
-6. Copy the webhook URL and run:
-
-```bash
-workscribe config set integrations.slackWebhook https://hooks.slack.com/services/...
-```
-
-Works on all Slack plans including free. No admin role required.
-
-Summaries posted to Slack are automatically formatted — headings are bolded, bullets converted to `•`, and your OS username is prepended so recipients know who sent it in shared channels. Custom `--webhook` URLs receive the raw markdown output unchanged.
-
-Config is stored at `~/.workscribe/config.json`.
+**[Full configuration reference →](https://workscribe.mintlify.site/configuration)** — every key, Slack setup, webhooks, and more.
 
 ## Debug mode
 
@@ -195,6 +125,8 @@ If capture isn't working, set `WORKSCRIBE_DEBUG=1` to write errors to `~/.worksc
 WORKSCRIBE_DEBUG=1 workscribe status
 ```
 
+**[Troubleshooting →](https://workscribe.mintlify.site/troubleshooting)**
+
 ## License
 
 MIT

package/dist/index.js

@@ -4145,7 +4145,7 @@ function registerBugReport(program) {
     const timestamp = (/* @__PURE__ */ new Date()).toISOString().replace(/[:.]/g, "-");
     const reportPath = import_path17.default.join(WORKSCRIBE_DIR, `bug-report-${timestamp}.txt`);
     const systemInfo = [
-      `Workscribe version : ${"1.15.4"}`,
+      `Workscribe version : ${"1.15.6"}`,
       `Node.js version    : ${process.version}`,
       `Platform           : ${process.platform}`,
       `Architecture       : ${process.arch}`,
@@ -4176,7 +4176,7 @@ function registerBugReport(program) {
       process.exit(1);
     }
     const params = new URLSearchParams({
-      title: `Bug report \u2014 workscribe ${"1.15.4"}`,
+      title: `Bug report \u2014 workscribe ${"1.15.6"}`,
       body: `<!-- Attach ${import_path17.default.basename(reportPath)} or paste the relevant sections below -->
 
 **Describe the issue:**
@@ -4376,7 +4376,7 @@ function isNewer(latest, current) {
   return latestPatch > currentPatch;
 }
 function checkForUpdate() {
-  const current = "1.15.4";
+  const current = "1.15.6";
   const cache = readCache();
   if (cache && isNewer(cache.latestVersion, current)) {
     process.stderr.write(
@@ -4399,7 +4399,7 @@ function checkForUpdate() {
 function buildTelemetryPayload(config) {
   return {
     installId: config.telemetry.installId,
-    cliVersion: "1.15.4",
+    cliVersion: "1.15.6",
     platform: import_os10.default.platform(),
     nodeVersion: process.version
   };
@@ -4474,7 +4474,7 @@ var require_main = __commonJS({
       pingTelemetry();
     }
     var program = new import_commander.Command();
-    program.name("workscribe").description("Automatic developer work journal").version("1.15.4");
+    program.name("workscribe").description("Automatic developer work journal").version("1.15.6");
     registerCapture(program);
     registerHook(program);
     registerInit(program);

package/package.json

@@ -1,7 +1,29 @@
 {
   "name": "@workscribe/cli",
-  "version": "1.15.4",
+  "version": "1.15.6",
   "description": "Passive developer work journal — automatic terminal activity summaries",
+  "homepage": "https://workscribe.co",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/workscribe/cli"
+  },
+  "bugs": {
+    "url": "https://github.com/workscribe/cli/issues"
+  },
+  "keywords": [
+    "cli",
+    "developer-tools",
+    "terminal",
+    "journal",
+    "work-journal",
+    "standup",
+    "productivity",
+    "ai",
+    "summary",
+    "git",
+    "time-tracking",
+    "shell"
+  ],
   "type": "commonjs",
   "bin": {
     "workscribe": "dist/index.js"
@@ -29,13 +51,6 @@
     "dist",
     "shell"
   ],
-  "keywords": [
-    "developer-tools",
-    "journal",
-    "terminal",
-    "productivity",
-    "standup"
-  ],
   "author": "Mark Edomwande",
   "license": "MIT",
   "dependencies": {