@gatherdeal/cli 0.1.0 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +50 -6
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -3,8 +3,45 @@
3
3
  Read and manage your GatherDeal business data from the terminal or an AI agent.
4
4
  This package launches the platform-specific `gatherdeal` binary.
5
5
 
6
+ ## Quick start
7
+
8
+ ### Run it yourself
9
+
6
10
  ```sh
11
+ npm install -g @gatherdeal/cli@latest --ignore-scripts
7
12
  gatherdeal auth login
13
+ gatherdeal outlets list
14
+ gatherdeal crm contacts list --limit 10
15
+ ```
16
+
17
+ `auth login` prints an approval page address and a code; open the page,
18
+ check the code and approve.
19
+
20
+ ### Hand it to your AI agent
21
+
22
+ Paste this prompt into your agent (Claude Code, Codex or another agent):
23
+
24
+ ```text
25
+ Install the GatherDeal CLI and its agent skill for me, then help me log in.
26
+
27
+ 1. Install the CLI: npm install -g @gatherdeal/cli@latest --ignore-scripts
28
+ (without npm, follow https://github.com/gatherdeal/cli#install).
29
+ 2. Check it: gatherdeal version
30
+ 3. Install the agent skill for yourself, for all my projects:
31
+ - Claude Code: gatherdeal skills install --target claude --scope user
32
+ - Codex or another agent that reads ~/.agents/skills:
33
+ gatherdeal skills install --target agents --scope user
34
+ 4. Read the usage rules: gatherdeal agent-context
35
+ 5. Log me in: run gatherdeal auth login --no-wait and show me the approval
36
+ link and code exactly as printed. I approve it myself in my browser; never
37
+ approve it for me and never ask for my password. When I say it is done,
38
+ run gatherdeal auth login --continue, then gatherdeal auth status, and tell
39
+ me which organization, outlets and permissions I granted.
40
+ ```
41
+
42
+ ## Usage
43
+
44
+ ```sh
8
45
  gatherdeal auth status
9
46
  gatherdeal crm contacts list --search ali
10
47
  gatherdeal crm contacts get <contact-id> --with-emails --with-tags
@@ -30,18 +67,23 @@ login options, pagination, output envelopes, and exit codes.
30
67
 
31
68
  ## Agent skill
32
69
 
33
- Install only when the person asks, with an explicit location:
70
+ Install only when the person asks (or to refresh it, see below), with an
71
+ explicit location:
34
72
 
35
73
  ```sh
36
74
  gatherdeal skills install --dir /path/to/skills
37
75
  gatherdeal skills install --target claude --scope project
38
76
  gatherdeal skills install --target claude --scope user
77
+ gatherdeal skills install --target agents --scope project
78
+ gatherdeal skills install --target agents --scope user
39
79
  gatherdeal skills show
40
80
  ```
41
81
 
42
- `--dir PATH` installs to `PATH/gatherdeal/`. Claude project scope installs
43
- to `./.claude/skills/gatherdeal/`; user scope installs to
44
- `$HOME/.claude/skills/gatherdeal/` using the OS home directory. Choose exactly
82
+ `--dir PATH` installs to `PATH/gatherdeal/`. `--target claude` (Claude Code)
83
+ installs to `.claude/skills/gatherdeal/` and `--target agents` (Codex and
84
+ other agents that read the shared agent-skills directory) to
85
+ `.agents/skills/gatherdeal/`, under the current directory with
86
+ `--scope project` or the OS home directory with `--scope user`. Choose exactly
45
87
  one of `--dir` or `--target`; `--scope` is required with `--target` and
46
88
  rejected with `--dir`. There is no default location.
47
89
 
@@ -55,8 +97,10 @@ subdirectories are refused. With --target, resolved destinations must stay
55
97
  inside the resolved project/home base. Explicit --dir follows ancestor symlinks.
56
98
  Success returns a JSON envelope with the absolute `dir`, `cli_version`, and
57
99
  per-file `path` and `action` (`created`, `updated`, or `unchanged`).
58
- `skills show` prints the skill as plain text. After upgrading the CLI,
59
- re-run the install command with the same location and `--force`.
100
+ `skills show` prints the skill as plain text. The skill records the CLI
101
+ version it was made for (`cli_version`); after the CLI changes version,
102
+ re-run the install command with the same location and `--force`. The skill
103
+ tells agents to do this when `gatherdeal version` reports a different version.
60
104
 
61
105
 
62
106
  ## Updates
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gatherdeal/cli",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Read and manage your GatherDeal business data from the terminal or an AI agent.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -19,11 +19,11 @@
19
19
  "node": ">=18"
20
20
  },
21
21
  "optionalDependencies": {
22
- "@gatherdeal/cli-linux-x64": "0.1.0",
23
- "@gatherdeal/cli-linux-arm64": "0.1.0",
24
- "@gatherdeal/cli-darwin-x64": "0.1.0",
25
- "@gatherdeal/cli-darwin-arm64": "0.1.0",
26
- "@gatherdeal/cli-win32-x64": "0.1.0",
27
- "@gatherdeal/cli-win32-arm64": "0.1.0"
22
+ "@gatherdeal/cli-linux-x64": "0.1.1",
23
+ "@gatherdeal/cli-linux-arm64": "0.1.1",
24
+ "@gatherdeal/cli-darwin-x64": "0.1.1",
25
+ "@gatherdeal/cli-darwin-arm64": "0.1.1",
26
+ "@gatherdeal/cli-win32-x64": "0.1.1",
27
+ "@gatherdeal/cli-win32-arm64": "0.1.1"
28
28
  }
29
29
  }