@kamilio/wire 0.1.4 → 0.1.5

package/README.md

@@ -1,8 +1,10 @@
 # Wire
 
+[![npm](https://img.shields.io/npm/v/%40kamilio%2Fwire)](https://www.npmjs.com/package/@kamilio/wire)
+
 Sync Notion, Google Docs, Slack, Gmail, Asana, ChatGPT, and Zoom into local Markdown.
 
-Wire turns web-based knowledge into files your editor, repo, scripts, and coding agents can use. Attach a source URL once, edit or review it as Markdown, then sync it again when the source changes.
+Wire turns web resources into files your editor, repo, and coding agents can use. Attach a URL once, edit it as Markdown, and sync — pulling remote changes down and pushing supported local edits back.
 
 ## Install
 
@@ -10,41 +12,78 @@ Wire turns web-based knowledge into files your editor, repo, scripts, and coding
 npm install -g @kamilio/wire
 ```
 
-## Start
+Requires Node 20+.
+
+## Quick Start
 
 ```sh
-wire init
-wire https://www.notion.so/example/page
-wire sync-all
+wire init                                  # initialize a workspace
+wire notion login                          # authenticate a service once
+wire https://www.notion.so/example/page    # attach a URL as tracked Markdown
+wire sync-all                              # refresh everything, push local edits back
 ```
 
-Use `wire <url>` to attach a supported resource as a tracked Markdown file. Use `wire sync <file>` or `wire sync-all` to refresh local files and push supported edits back.
+## Providers
 
-## Why Wire
+| Provider | Resources | Sync |
+| --- | --- | --- |
+| Notion | Pages | Two-way |
+| Google Docs | Documents | Two-way |
+| Google Sheets | Spreadsheets | Two-way |
+| Google Slides | Presentations | One-way |
+| Google Forms | Forms | Two-way |
+| Asana | Projects | Two-way |
+| Asana | Tasks | One-way |
+| Slack | Messages and threads | One-way |
+| Gmail | Email threads | One-way |
+| ChatGPT | Conversations | One-way |
+| Zoom | Docs and meeting transcripts | One-way |
 
-- Local Markdown for product docs, specs, research, meetings, tasks, messages, and saved chats
-- Two-way sync for supported resources instead of copy-paste drift
-- A CLI that fits normal shell, Git, editor, and agent workflows
-- `wire-mcp` for exposing the same tools to MCP clients
+Two-way syncs pull remote changes and push local Markdown edits back to the source. One-way syncs only refresh the local file.
+
+Each service authenticates separately with `wire <service> login`, `wire <service> status`, and `wire <service> logout`.
 
 ## Commands
 
 ```sh
+wire <url>               # attach a URL as tracked Markdown
 wire preview <url>       # inspect a resource without writing files
 wire download <url>      # save Markdown once without tracking it
-wire sync <file-or-url>  # sync one registered resource
+wire sync <file-or-url>  # sync one tracked resource
+wire sync-all            # sync the current directory tree
 wire open <resource>     # open the source and show local details
 wire detach <resource>   # download once, then stop tracking it
+wire watch <file>        # sync a file whenever it changes
 ```
 
-## Services
+Run `wire --help` for the full CLI.
+
+## MCP
+
+`wire-mcp` exposes the same tools to MCP clients over stdio:
+
+```json
+{ "mcpServers": { "wire": { "command": "wire-mcp" } } }
+```
 
-Wire supports Notion, Google Docs/Sheets/Slides/Forms, Slack, Gmail, Asana, ChatGPT, and Zoom.
+## Hooks
+
+Wire follows Husky-style lifecycle hooks: executable files in `.wire/hooks` run automatically, no enabling needed.
+
+- `.wire/hooks/post-resource` and `.wire/hooks/post-resource.d/*` — after each synced resource
+- `.wire/hooks/post-batch` — after a batch of syncs
+- `.wire/hooks/post-command` — after every command
+
+Hooks run from the workspace root with `WIRE_*` env vars such as `WIRE_COMMAND`, `WIRE_ROOT`, `WIRE_SERVICE`, `WIRE_TITLE`, `WIRE_PATH`, and `WIRE_RESULT_COUNT`. Exit non-zero to fail Wire. Example `post-resource` hook that files docs by service:
 
 ```sh
-wire notion login
-wire google-docs login
-wire slack login
+mkdir -p "docs/$WIRE_SERVICE" && dest="docs/$WIRE_SERVICE/$WIRE_TITLE.md" && mv "$WIRE_PATH" "$dest" && echo "WIRE_PATH=$dest"
 ```
 
-Run `wire --help` for the full CLI.
+## Configuration
+
+Workspace config lives in `.wire/config.json` and applies to Wire plus hooks:
+
+```json
+{ "backend": "sqlite", "path": "registry.sqlite3", "env": { "WIRE_CUSTOM_VALUE": "example" } }
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kamilio/wire",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Attach Notion, Google Docs, Slack, Gmail, Asana, ChatGPT, and Zoom resources as local Markdown you can sync.",
   "keywords": [
     "markdown",
@@ -87,8 +87,8 @@
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "dev-link": "npm link",
-    "prepack": "rm -rf node_modules && mkdir -p node_modules && for package in provider-asana provider-chatgpt provider-gmail provider-google-docs provider-notion provider-slack provider-zoom wire-core; do cp -R ../$package node_modules/$package; done && for package in ajv commander fast-deep-equal fast-string-truncated-width fast-string-width fast-wrap-ansi fast-uri ignore jose jsonc-parser json-schema-traverse pct-encode require-from-string sisteransi smol-toml tiny-stdio-mcp-server toolcraft toolcraft-schema uri-template uri-template-lite yaml; do cp -R ../../node_modules/$package node_modules/$package; done",
-    "postpack": "rm -rf node_modules",
+    "prepack": "cp ../../README.md README.md && rm -rf node_modules && mkdir -p node_modules && for package in provider-asana provider-chatgpt provider-gmail provider-google-docs provider-notion provider-slack provider-zoom wire-core; do cp -R ../$package node_modules/$package; done && for package in ajv commander fast-deep-equal fast-string-truncated-width fast-string-width fast-wrap-ansi fast-uri ignore jose jsonc-parser json-schema-traverse pct-encode require-from-string sisteransi smol-toml tiny-stdio-mcp-server toolcraft toolcraft-schema uri-template uri-template-lite yaml; do cp -R ../../node_modules/$package node_modules/$package; done",
+    "postpack": "rm -rf node_modules README.md",
     "test": "node --test --test-concurrency=1 test/**/*.test.mjs",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "check": "npm run typecheck && npm run build && npm test"