@gatherdeal/cli 0.1.0 → 0.1.2

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 +75 -7
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -3,15 +3,57 @@
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
+ # Optional: let your AI agent use it (Claude Code, Codex and others)
17
+ gatherdeal skills install --target claude --scope user
18
+ gatherdeal skills install --target agents --scope user
19
+ ```
20
+
21
+ `auth login` prints an approval page address and a code; open the page,
22
+ check the code and approve.
23
+
24
+ ### Hand it to your AI agent
25
+
26
+ Paste this prompt into your agent (Claude Code, Codex or another agent):
27
+
28
+ ```text
29
+ Install the GatherDeal CLI and its agent skill for me, then help me log in.
30
+
31
+ 1. Install the CLI: npm install -g @gatherdeal/cli@latest --ignore-scripts
32
+ (without npm, follow https://github.com/gatherdeal/cli#install).
33
+ 2. Check it: gatherdeal version
34
+ 3. Install the agent skill for yourself, for all my projects:
35
+ - Claude Code: gatherdeal skills install --target claude --scope user
36
+ - Codex or another agent that reads ~/.agents/skills:
37
+ gatherdeal skills install --target agents --scope user
38
+ 4. Read the usage rules: gatherdeal agent-context
39
+ 5. Log me in: run gatherdeal auth login --no-wait and show me the approval
40
+ link and code exactly as printed. I approve it myself in my browser; never
41
+ approve it for me and never ask for my password. When I say it is done,
42
+ run gatherdeal auth login --continue, then gatherdeal auth status, and tell
43
+ me which organization, outlets and permissions I granted.
44
+ ```
45
+
46
+ ## Usage
47
+
48
+ ```sh
8
49
  gatherdeal auth status
9
50
  gatherdeal crm contacts list --search ali
10
51
  gatherdeal crm contacts get <contact-id> --with-emails --with-tags
11
52
  ```
12
53
 
13
54
  App API commands use `gatherdeal <app> <resource> <verb>`. Authentication,
14
- `commands`, `agent-context`, `skills`, `update`, and `version` stay top-level.
55
+ `commands`, `agent-context`, `skills`, `update`, `uninstall` and `version` stay
56
+ top-level.
15
57
 
16
58
  ```sh
17
59
  gatherdeal --help
@@ -30,18 +72,23 @@ login options, pagination, output envelopes, and exit codes.
30
72
 
31
73
  ## Agent skill
32
74
 
33
- Install only when the person asks, with an explicit location:
75
+ Install only when the person asks (or to refresh it, see below), with an
76
+ explicit location:
34
77
 
35
78
  ```sh
36
79
  gatherdeal skills install --dir /path/to/skills
37
80
  gatherdeal skills install --target claude --scope project
38
81
  gatherdeal skills install --target claude --scope user
82
+ gatherdeal skills install --target agents --scope project
83
+ gatherdeal skills install --target agents --scope user
39
84
  gatherdeal skills show
40
85
  ```
41
86
 
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
87
+ `--dir PATH` installs to `PATH/gatherdeal/`. `--target claude` (Claude Code)
88
+ installs to `.claude/skills/gatherdeal/` and `--target agents` (Codex and
89
+ other agents that read the shared agent-skills directory) to
90
+ `.agents/skills/gatherdeal/`, under the current directory with
91
+ `--scope project` or the OS home directory with `--scope user`. Choose exactly
45
92
  one of `--dir` or `--target`; `--scope` is required with `--target` and
46
93
  rejected with `--dir`. There is no default location.
47
94
 
@@ -53,10 +100,14 @@ index and core commands, as `gatherdeal agent-context` prints them) and one
53
100
  fail before any writes unless `--force` is given; symlinked skill files and
54
101
  subdirectories are refused. With --target, resolved destinations must stay
55
102
  inside the resolved project/home base. Explicit --dir follows ancestor symlinks.
103
+ The install location is recorded in the config directory so
104
+ `gatherdeal uninstall` can remove it.
56
105
  Success returns a JSON envelope with the absolute `dir`, `cli_version`, and
57
106
  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`.
107
+ `skills show` prints the skill as plain text. The skill records the CLI
108
+ version it was made for (`cli_version`); after the CLI changes version,
109
+ re-run the install command with the same location and `--force`. The skill
110
+ tells agents to do this when `gatherdeal version` reports a different version.
60
111
 
61
112
 
62
113
  ## Updates
@@ -65,3 +116,20 @@ re-run the install command with the same location and `--force`.
65
116
  installation instructions (exit 9 when an external install is needed).
66
117
  All forms are read-only, with no disk cache or self-replacement and no
67
118
  `--yes` flag. Use `--version <version>` to select an exact release.
119
+
120
+ ## Uninstall
121
+
122
+ ```sh
123
+ gatherdeal uninstall # show the plan; changes nothing
124
+ gatherdeal uninstall --yes # carry it out
125
+ npm uninstall -g @gatherdeal/cli
126
+ ```
127
+
128
+ `uninstall --yes` revokes every profile's access on its server, deletes the
129
+ stored credentials, the agent skills `skills install` wrote (only directories
130
+ that hold exactly the generated skill) and the config directory. If an
131
+ access cannot be revoked, it stops and keeps that profile; revoke the access
132
+ at passport › Security › Sessions & devices and run
133
+ `gatherdeal uninstall --yes --local-only` to delete the local state anyway.
134
+ The CLI never deletes its own binary: remove the package last. See the
135
+ [repository README](https://github.com/gatherdeal/cli#uninstall) for details.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gatherdeal/cli",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
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.2",
23
+ "@gatherdeal/cli-linux-arm64": "0.1.2",
24
+ "@gatherdeal/cli-darwin-x64": "0.1.2",
25
+ "@gatherdeal/cli-darwin-arm64": "0.1.2",
26
+ "@gatherdeal/cli-win32-x64": "0.1.2",
27
+ "@gatherdeal/cli-win32-arm64": "0.1.2"
28
28
  }
29
29
  }