@gatherdeal/cli 0.1.0 → 0.1.1

package/README.md

@@ -3,8 +3,45 @@
 Read and manage your GatherDeal business data from the terminal or an AI agent.
 This package launches the platform-specific `gatherdeal` binary.
 
+## Quick start
+
+### Run it yourself
+
 ```sh
+npm install -g @gatherdeal/cli@latest --ignore-scripts
 gatherdeal auth login
+gatherdeal outlets list
+gatherdeal crm contacts list --limit 10
+```
+
+`auth login` prints an approval page address and a code; open the page,
+check the code and approve.
+
+### Hand it to your AI agent
+
+Paste this prompt into your agent (Claude Code, Codex or another agent):
+
+```text
+Install the GatherDeal CLI and its agent skill for me, then help me log in.
+
+1. Install the CLI: npm install -g @gatherdeal/cli@latest --ignore-scripts
+   (without npm, follow https://github.com/gatherdeal/cli#install).
+2. Check it: gatherdeal version
+3. Install the agent skill for yourself, for all my projects:
+   - Claude Code: gatherdeal skills install --target claude --scope user
+   - Codex or another agent that reads ~/.agents/skills:
+     gatherdeal skills install --target agents --scope user
+4. Read the usage rules: gatherdeal agent-context
+5. Log me in: run gatherdeal auth login --no-wait and show me the approval
+   link and code exactly as printed. I approve it myself in my browser; never
+   approve it for me and never ask for my password. When I say it is done,
+   run gatherdeal auth login --continue, then gatherdeal auth status, and tell
+   me which organization, outlets and permissions I granted.
+```
+
+## Usage
+
+```sh
 gatherdeal auth status
 gatherdeal crm contacts list --search ali
 gatherdeal crm contacts get <contact-id> --with-emails --with-tags
@@ -30,18 +67,23 @@ login options, pagination, output envelopes, and exit codes.
 
 ## Agent skill
 
-Install only when the person asks, with an explicit location:
+Install only when the person asks (or to refresh it, see below), with an
+explicit location:
 
 ```sh
 gatherdeal skills install --dir /path/to/skills
 gatherdeal skills install --target claude --scope project
 gatherdeal skills install --target claude --scope user
+gatherdeal skills install --target agents --scope project
+gatherdeal skills install --target agents --scope user
 gatherdeal skills show
 ```
 
-`--dir PATH` installs to `PATH/gatherdeal/`. Claude project scope installs
-to `./.claude/skills/gatherdeal/`; user scope installs to
-`$HOME/.claude/skills/gatherdeal/` using the OS home directory. Choose exactly
+`--dir PATH` installs to `PATH/gatherdeal/`. `--target claude` (Claude Code)
+installs to `.claude/skills/gatherdeal/` and `--target agents` (Codex and
+other agents that read the shared agent-skills directory) to
+`.agents/skills/gatherdeal/`, under the current directory with
+`--scope project` or the OS home directory with `--scope user`. Choose exactly
 one of `--dir` or `--target`; `--scope` is required with `--target` and
 rejected with `--dir`. There is no default location.
 
@@ -55,8 +97,10 @@ subdirectories are refused. With --target, resolved destinations must stay
 inside the resolved project/home base. Explicit --dir follows ancestor symlinks.
 Success returns a JSON envelope with the absolute `dir`, `cli_version`, and
 per-file `path` and `action` (`created`, `updated`, or `unchanged`).
-`skills show` prints the skill as plain text. After upgrading the CLI,
-re-run the install command with the same location and `--force`.
+`skills show` prints the skill as plain text. The skill records the CLI
+version it was made for (`cli_version`); after the CLI changes version,
+re-run the install command with the same location and `--force`. The skill
+tells agents to do this when `gatherdeal version` reports a different version.
 
 
 ## Updates

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gatherdeal/cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Read and manage your GatherDeal business data from the terminal or an AI agent.",
   "license": "Apache-2.0",
   "repository": {
@@ -19,11 +19,11 @@
     "node": ">=18"
   },
   "optionalDependencies": {
-    "@gatherdeal/cli-linux-x64": "0.1.0",
-    "@gatherdeal/cli-linux-arm64": "0.1.0",
-    "@gatherdeal/cli-darwin-x64": "0.1.0",
-    "@gatherdeal/cli-darwin-arm64": "0.1.0",
-    "@gatherdeal/cli-win32-x64": "0.1.0",
-    "@gatherdeal/cli-win32-arm64": "0.1.0"
+    "@gatherdeal/cli-linux-x64": "0.1.1",
+    "@gatherdeal/cli-linux-arm64": "0.1.1",
+    "@gatherdeal/cli-darwin-x64": "0.1.1",
+    "@gatherdeal/cli-darwin-arm64": "0.1.1",
+    "@gatherdeal/cli-win32-x64": "0.1.1",
+    "@gatherdeal/cli-win32-arm64": "0.1.1"
   }
 }