@shuffl/cli 0.3.0 → 0.5.0
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 +17 -3
- package/dist/commands.generated.js +4594 -1698
- package/dist/index.js +64 -35
- package/dist/types.d.ts +2 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ shuffl --help
|
|
|
14
14
|
|
|
15
15
|
Or run it without installing: `npx @shuffl/cli --help`. To pin it in a project, add `@shuffl/cli` as a dev dependency and run `npx shuffl`. The CLI is built on [`@shuffl/sdk`](https://www.npmjs.com/package/@shuffl/sdk) and released with it under one version; its operation names, help and input flags are generated from the public API contract.
|
|
16
16
|
|
|
17
|
-
`shuffl permissions list --json` discovers endpoint grants. Each command’s `--help` shows its permission ID and Read/Write classification. Create a delegated key with `shuffl credentials api create --input-file key-command.json --json`, using a `permissions` array such as `["users.list", "
|
|
17
|
+
`shuffl permissions list --json` discovers endpoint grants. Each command’s `--help` shows its permission ID and Read/Write classification. Create a delegated key with `shuffl credentials api create --input-file key-command.json --json`, using a `permissions` array such as `["users.list", "groups.save"]`. The issuer must hold `credentials.api.create` and every requested permission. See [endpoint permissions](https://shuffl-rebuild.vercel.app/docs/api-permissions).
|
|
18
18
|
|
|
19
19
|
## Authentication and commands
|
|
20
20
|
|
|
@@ -48,12 +48,26 @@ Programs are created paused by default. Keep the same `requestKey` for a retry,
|
|
|
48
48
|
Management resources use the same nested command names as the [SDK](https://shuffl-rebuild.vercel.app/docs/sdk):
|
|
49
49
|
|
|
50
50
|
```sh
|
|
51
|
-
shuffl
|
|
52
|
-
shuffl
|
|
51
|
+
shuffl groups list --json
|
|
52
|
+
shuffl groups save --input-file group-command.json --json
|
|
53
53
|
shuffl commands get --id RECEIPT_ID --json
|
|
54
54
|
shuffl knowledge sources import-pdf --input-file pdf-command.json --json
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
Management writes require `requestKey` and return `{receipt, result}`. Sensitive writes also require `confirm` equal to the SDK operation name. Keep the same input/key on retry: the duplicate returns only the receipt and `result: null`, without repeating the write or disclosing an old result. Read current resources to reconcile an unknown outcome.
|
|
58
58
|
|
|
59
|
+
## Company settings
|
|
60
|
+
|
|
61
|
+
Commands under `shuffl company` take a company key (`shuffl_company_`) from **Company settings → API keys** instead of a workspace key:
|
|
62
|
+
|
|
63
|
+
```sh
|
|
64
|
+
credential-command | shuffl login --company --base-url https://YOUR-SHUFFL-HOST --token-stdin
|
|
65
|
+
shuffl company current --json
|
|
66
|
+
shuffl company members list --limit 100 --json
|
|
67
|
+
shuffl company members remove --user-id USER_ID --json
|
|
68
|
+
shuffl logout --company
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Or set `SHUFFL_COMPANY_KEY` and `SHUFFL_BASE_URL`. The company key is saved in `company.json` next to `config.json`, and only `shuffl company` commands send it; `shuffl logout --company` removes it. Each command's `--help` names its company permission. See [company keys](https://shuffl-rebuild.vercel.app/docs/api-permissions#company-keys).
|
|
72
|
+
|
|
59
73
|
Full guide: [Use the Shuffl CLI](https://shuffl-rebuild.vercel.app/docs/cli).
|