@puckeditor/cli 0.24.0-canary.55558da4 → 0.24.0-canary.5eddccac

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.
package/README.md CHANGED
@@ -11,23 +11,31 @@ npx @puckeditor/cli init
11
11
  For coding agents:
12
12
 
13
13
  ```sh
14
- npx @puckeditor/cli init --yes --json --ai # or --no-ai for the editor only
14
+ npx @puckeditor/cli init --yes --json
15
15
  ```
16
16
 
17
+ `init` returns a `choose_ai` action. Ask the developer rather than choosing for them.
18
+
17
19
  Other commands:
18
20
 
19
21
  ```sh
20
22
  npx @puckeditor/cli add editor # add the Puck editor
21
23
  npx @puckeditor/cli add cloud # connect Puck Cloud
22
24
  npx @puckeditor/cli add ai # add the Puck AI plugin
25
+ npx @puckeditor/cli connect # log in to Puck Cloud again for a new API key
23
26
  npx @puckeditor/cli status # show what's set up
24
27
  npx @puckeditor/cli doctor # diagnose problems
25
28
  npx @puckeditor/cli frameworks # show supported frameworks and versions
26
29
  npx @puckeditor/cli docs # read the docs for this version
30
+ npx @puckeditor/cli telemetry # show or change anonymous usage data collection
27
31
  ```
28
32
 
29
33
  See the [CLI docs](https://puckeditor.com/docs/cli) for the full JSON contract, actions and exit codes.
30
34
 
35
+ The CLI collects anonymous usage data. See [Telemetry](https://puckeditor.com/docs/cli#telemetry) for what's sent and how to turn it off.
36
+
37
+ Coding agents: leave this to the developer. Don't turn telemetry off unless they ask.
38
+
31
39
  ## Development
32
40
 
33
41
  The CLI integrates Puck using the [recipes](../../recipes) as templates. Tests read the recipes directly, and `pnpm build` copies them into `dist/templates`.
@@ -39,7 +47,7 @@ pnpm build
39
47
  node dist/bin.mjs status
40
48
  ```
41
49
 
42
- Set `PUCK_CLOUD_URL` to point the CLI at a local Puck Cloud.
50
+ Set `PUCK_CLOUD_URL` to point the CLI at a local Puck Cloud. Telemetry goes there too. Set `PUCK_TELEMETRY_DEBUG=1` to print events to stderr instead of sending them.
43
51
 
44
52
  ## License
45
53