@puckeditor/cli 0.24.0-canary.6f40e09b → 0.24.0-canary.8e71f34e
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 +13 -2
- package/dist/bin.mjs +3579 -727
- package/dist/docs/ai/ai-configuration.md +246 -0
- package/dist/docs/ai/business-context.md +69 -0
- package/dist/docs/ai/custom-agents.md +133 -0
- package/dist/docs/ai/design-mode.md +177 -0
- package/dist/docs/ai/getting-started.md +185 -0
- package/dist/docs/ai/headless-generation.md +155 -0
- package/dist/docs/ai/localization.md +43 -0
- package/dist/docs/ai/model-configuration.md +113 -0
- package/dist/docs/ai/overview.md +21 -0
- package/dist/docs/ai/tools.md +99 -0
- package/dist/docs/api-reference/ai/ai-plugin/create-ai-plugin.md +307 -0
- package/dist/docs/api-reference/ai/ai-plugin/dictionary.md +77 -0
- package/dist/docs/api-reference/ai/ai-plugin/installation.md +14 -0
- package/dist/docs/api-reference/ai/ai-plugin/use-puck-ai.md +175 -0
- package/dist/docs/api-reference/ai/ai-plugin/with-dynamic-config.md +35 -0
- package/dist/docs/api-reference/ai/cloud-client/chat.md +496 -0
- package/dist/docs/api-reference/ai/cloud-client/generate.md +546 -0
- package/dist/docs/api-reference/ai/cloud-client/installation.md +16 -0
- package/dist/docs/api-reference/ai/cloud-client/puck-handler.md +423 -0
- package/dist/docs/api-reference/ai/cloud-client/tool.md +128 -0
- package/dist/docs/api-reference/ai/configuration/components.md +72 -0
- package/dist/docs/api-reference/ai/configuration/fields.md +231 -0
- package/dist/docs/api-reference/components/action-bar-drag-handle.md +33 -0
- package/dist/docs/api-reference/components/field-group-item.md +39 -0
- package/dist/docs/api-reference/components/field-group.md +86 -0
- package/dist/docs/api-reference/components/field-tab.md +55 -0
- package/dist/docs/api-reference/data-model/ai-field-type.md +31 -0
- package/dist/docs/api-reference/data-model/ai-part.md +90 -0
- package/dist/docs/api-reference/fields/checkbox.md +87 -0
- package/dist/docs/api-reference/theming/field-tabs.md +28 -0
- package/dist/docs/cli.md +154 -47
- package/dist/docs/getting-started.md +2 -0
- package/dist/docs/index.json +124 -0
- package/dist/docs/integrating-puck/field-grouping.md +149 -0
- package/dist/templates/manifest.json +4 -1
- package/dist/templates/next/app/puck/[...puckPath]/page.tsx +3 -2
- package/dist/templates/next/app/puck/page.tsx +0 -2
- package/dist/templates/next-ai/app/puck/[...puckPath]/page.tsx +3 -2
- package/dist/templates/next-ai/app/puck/page.tsx +0 -2
- package/dist/templates/react-router/database.json +1 -1
- package/dist/templates/react-router/package.json +8 -8
- package/dist/templates/react-router-ai/database.json +1 -1
- package/dist/templates/react-router-ai/package.json +8 -8
- package/dist/templates/vinext/app/puck/[...puckPath]/page.tsx +3 -2
- package/dist/templates/vinext/app/puck/page.tsx +0 -2
- package/dist/templates/vinext-ai/app/puck/[...puckPath]/page.tsx +3 -2
- package/dist/templates/vinext-ai/app/puck/page.tsx +0 -2
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -11,24 +11,35 @@ npx @puckeditor/cli init
|
|
|
11
11
|
For coding agents:
|
|
12
12
|
|
|
13
13
|
```sh
|
|
14
|
-
npx @puckeditor/cli init --yes --json
|
|
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 pages import database.json # publish pages to Puck Cloud
|
|
23
28
|
npx @puckeditor/cli connect # log in to Puck Cloud again for a new API key
|
|
29
|
+
npx @puckeditor/cli connect preview # ...for a branch of the project
|
|
24
30
|
npx @puckeditor/cli status # show what's set up
|
|
25
31
|
npx @puckeditor/cli doctor # diagnose problems
|
|
26
32
|
npx @puckeditor/cli frameworks # show supported frameworks and versions
|
|
27
33
|
npx @puckeditor/cli docs # read the docs for this version
|
|
34
|
+
npx @puckeditor/cli telemetry # show or change anonymous usage data collection
|
|
28
35
|
```
|
|
29
36
|
|
|
30
37
|
See the [CLI docs](https://puckeditor.com/docs/cli) for the full JSON contract, actions and exit codes.
|
|
31
38
|
|
|
39
|
+
The CLI collects anonymous usage data. See [Telemetry](https://puckeditor.com/docs/cli#telemetry) for what's sent and how to turn it off.
|
|
40
|
+
|
|
41
|
+
Coding agents: leave this to the developer. Don't turn telemetry off unless they ask.
|
|
42
|
+
|
|
32
43
|
## Development
|
|
33
44
|
|
|
34
45
|
The CLI integrates Puck using the [recipes](../../recipes) as templates. Tests read the recipes directly, and `pnpm build` copies them into `dist/templates`.
|
|
@@ -40,7 +51,7 @@ pnpm build
|
|
|
40
51
|
node dist/bin.mjs status
|
|
41
52
|
```
|
|
42
53
|
|
|
43
|
-
Set `PUCK_CLOUD_URL` to point the CLI at a local Puck Cloud.
|
|
54
|
+
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.
|
|
44
55
|
|
|
45
56
|
## License
|
|
46
57
|
|