@puckeditor/cli 0.24.0-canary.924c1e20 → 0.24.0-canary.b20be8d3

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 (46) hide show
  1. package/README.md +7 -1
  2. package/dist/bin.mjs +1983 -474
  3. package/dist/docs/ai/ai-configuration.md +246 -0
  4. package/dist/docs/ai/business-context.md +69 -0
  5. package/dist/docs/ai/custom-agents.md +133 -0
  6. package/dist/docs/ai/design-mode.md +177 -0
  7. package/dist/docs/ai/getting-started.md +185 -0
  8. package/dist/docs/ai/headless-generation.md +155 -0
  9. package/dist/docs/ai/localization.md +43 -0
  10. package/dist/docs/ai/model-configuration.md +113 -0
  11. package/dist/docs/ai/overview.md +21 -0
  12. package/dist/docs/ai/tools.md +99 -0
  13. package/dist/docs/api-reference/ai/ai-plugin/create-ai-plugin.md +307 -0
  14. package/dist/docs/api-reference/ai/ai-plugin/dictionary.md +77 -0
  15. package/dist/docs/api-reference/ai/ai-plugin/installation.md +14 -0
  16. package/dist/docs/api-reference/ai/ai-plugin/use-puck-ai.md +175 -0
  17. package/dist/docs/api-reference/ai/ai-plugin/with-dynamic-config.md +35 -0
  18. package/dist/docs/api-reference/ai/cloud-client/chat.md +496 -0
  19. package/dist/docs/api-reference/ai/cloud-client/generate.md +546 -0
  20. package/dist/docs/api-reference/ai/cloud-client/installation.md +16 -0
  21. package/dist/docs/api-reference/ai/cloud-client/puck-handler.md +423 -0
  22. package/dist/docs/api-reference/ai/cloud-client/tool.md +128 -0
  23. package/dist/docs/api-reference/ai/configuration/components.md +72 -0
  24. package/dist/docs/api-reference/ai/configuration/fields.md +231 -0
  25. package/dist/docs/api-reference/components/action-bar-drag-handle.md +33 -0
  26. package/dist/docs/api-reference/components/field-group-item.md +39 -0
  27. package/dist/docs/api-reference/components/field-group.md +86 -0
  28. package/dist/docs/api-reference/components/field-tab.md +55 -0
  29. package/dist/docs/api-reference/data-model/ai-field-type.md +31 -0
  30. package/dist/docs/api-reference/data-model/ai-part.md +90 -0
  31. package/dist/docs/api-reference/fields/checkbox.md +87 -0
  32. package/dist/docs/api-reference/theming/field-tabs.md +28 -0
  33. package/dist/docs/cli.md +114 -44
  34. package/dist/docs/getting-started.md +2 -0
  35. package/dist/docs/index.json +124 -0
  36. package/dist/docs/integrating-puck/field-grouping.md +149 -0
  37. package/dist/templates/manifest.json +2 -1
  38. package/dist/templates/next/app/puck/[...puckPath]/page.tsx +3 -2
  39. package/dist/templates/next/app/puck/page.tsx +0 -2
  40. package/dist/templates/next-ai/app/puck/[...puckPath]/page.tsx +3 -2
  41. package/dist/templates/next-ai/app/puck/page.tsx +0 -2
  42. package/dist/templates/vinext/app/puck/[...puckPath]/page.tsx +3 -2
  43. package/dist/templates/vinext/app/puck/page.tsx +0 -2
  44. package/dist/templates/vinext-ai/app/puck/[...puckPath]/page.tsx +3 -2
  45. package/dist/templates/vinext-ai/app/puck/page.tsx +0 -2
  46. package/package.json +1 -1
package/README.md CHANGED
@@ -11,9 +11,11 @@ npx @puckeditor/cli init
11
11
  For coding agents:
12
12
 
13
13
  ```sh
14
- npx @puckeditor/cli init --yes --json --ai --pages --auth # or --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
@@ -22,7 +24,9 @@ npx @puckeditor/cli add cloud # connect Puck Cloud
22
24
  npx @puckeditor/cli add ai # add the Puck AI plugin
23
25
  npx @puckeditor/cli add pages # store and publish pages in Puck Cloud
24
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
25
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
26
30
  npx @puckeditor/cli connect # log in to Puck Cloud again for a new API key
27
31
  npx @puckeditor/cli connect preview # ...for a branch of the project
28
32
  npx @puckeditor/cli status # show what's set up
@@ -36,6 +40,8 @@ See the [CLI docs](https://puckeditor.com/docs/cli) for the full JSON contract,
36
40
 
37
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.
38
42
 
43
+ Coding agents: leave this to the developer. Don't turn telemetry off unless they ask.
44
+
39
45
  ## Development
40
46
 
41
47
  The CLI integrates Puck using the [recipes](../../recipes) as templates. Tests read the recipes directly, and `pnpm build` copies them into `dist/templates`.