@puckeditor/cli 0.24.0-canary.55558da4 → 0.24.0-canary.614259f0

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,37 @@ 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_capabilities` action. Ask the developer which to include 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 add pages # store and publish pages in Puck Cloud
26
+ npx @puckeditor/cli add auth # require Sign in with Puck to edit
27
+ npx @puckeditor/cli add assets # upload and manage images and files in Puck Cloud
28
+ npx @puckeditor/cli pages import database.json # publish pages to Puck Cloud
29
+ npx @puckeditor/cli assets migrate # switch image fields to the asset library
30
+ npx @puckeditor/cli connect # log in to Puck Cloud again for a new API key
31
+ npx @puckeditor/cli connect preview # ...for a branch of the project
23
32
  npx @puckeditor/cli status # show what's set up
24
33
  npx @puckeditor/cli doctor # diagnose problems
25
34
  npx @puckeditor/cli frameworks # show supported frameworks and versions
26
35
  npx @puckeditor/cli docs # read the docs for this version
36
+ npx @puckeditor/cli telemetry # show or change anonymous usage data collection
27
37
  ```
28
38
 
29
39
  See the [CLI docs](https://puckeditor.com/docs/cli) for the full JSON contract, actions and exit codes.
30
40
 
41
+ The CLI collects anonymous usage data. See [Telemetry](https://puckeditor.com/docs/cli#telemetry) for what's sent and how to turn it off.
42
+
43
+ Coding agents: leave this to the developer. Don't turn telemetry off unless they ask.
44
+
31
45
  ## Development
32
46
 
33
47
  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 +53,7 @@ pnpm build
39
53
  node dist/bin.mjs status
40
54
  ```
41
55
 
42
- Set `PUCK_CLOUD_URL` to point the CLI at a local Puck Cloud.
56
+ 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
57
 
44
58
  ## License
45
59