@shuffl/cli 0.7.6 → 0.7.7
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 +7 -7
- package/package.json +4 -4
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", "groups.save"]`. The issuer must hold `credentials.api.create` and every requested permission. See [endpoint permissions](https://shuffl
|
|
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.ai/docs/api-permissions).
|
|
18
18
|
|
|
19
19
|
## Authentication and commands
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Create an API key in **Settings → API keys**, choosing only the endpoint permi
|
|
|
22
22
|
|
|
23
23
|
```sh
|
|
24
24
|
# Your credential manager supplies the token on stdin.
|
|
25
|
-
credential-command | shuffl login --base-url https://
|
|
25
|
+
credential-command | shuffl login --base-url https://shuffl.ai --token-stdin
|
|
26
26
|
|
|
27
27
|
shuffl users list --limit 25 --json
|
|
28
28
|
shuffl programs list --json
|
|
@@ -35,7 +35,7 @@ shuffl logout
|
|
|
35
35
|
|
|
36
36
|
Alternatively set `SHUFFL_API_KEY` and `SHUFFL_BASE_URL` through your environment. Tokens are never accepted as command-line arguments or printed after login. Saved credentials are stored with mode `0600` under `$XDG_CONFIG_HOME/shuffl/config.json` (default `~/.config/shuffl/config.json`). `SHUFFL_CONFIG_DIR` overrides the Shuffl directory. Logout removes the local copy; revoke the token in Settings to disable other copies.
|
|
37
37
|
|
|
38
|
-
The saved token cannot be used with a different `--base-url`; log into that server or supply an explicit environment token. Login verifies the token before saving it.
|
|
38
|
+
The saved token cannot be used with a different `--base-url`; log into that server or supply an explicit environment token. Login verifies the token before saving it. For production, use `https://shuffl.ai`. If your saved login uses the old Vercel host, log in again with the canonical URL; environment-based setups must update `SHUFFL_BASE_URL`.
|
|
39
39
|
|
|
40
40
|
Select the team when creating the token. Each token controls exactly that team; switching teams requires a token issued there. There is no team flag that can broaden the token's authority. `shuffl teams current --json` reads back the selected team. `users list` accepts `--limit` (1–100) and `--cursor` from the previous response's `nextCursor`; other resources retain the pagination fields shown by their command help.
|
|
41
41
|
|
|
@@ -45,7 +45,7 @@ Every operation accepts `--input JSON`, `--input -` for stdin, or `--input-file
|
|
|
45
45
|
|
|
46
46
|
Programs are created paused by default. Keep the same `requestKey` for a retry, and use `expectedRevision` to update the version you reviewed. Activating a program enables its schedule. A requested run is queued durably and can be inspected with `shuffl runs get --id RUN_ID`.
|
|
47
47
|
|
|
48
|
-
Management resources use the same nested command names as the [SDK](https://shuffl
|
|
48
|
+
Management resources use the same nested command names as the [SDK](https://shuffl.ai/docs/sdk):
|
|
49
49
|
|
|
50
50
|
```sh
|
|
51
51
|
shuffl groups list --json
|
|
@@ -61,16 +61,16 @@ Management writes require `requestKey` and return `{receipt, result}`. Sensitive
|
|
|
61
61
|
Commands under `shuffl company` take a company key (`shuffl_company_`) from **Company settings → API keys** instead of a workspace key:
|
|
62
62
|
|
|
63
63
|
```sh
|
|
64
|
-
credential-command | shuffl login --company --base-url https://
|
|
64
|
+
credential-command | shuffl login --company --base-url https://shuffl.ai --token-stdin
|
|
65
65
|
shuffl company current --json
|
|
66
66
|
shuffl company members list --limit 100 --json
|
|
67
67
|
shuffl company members remove --user-id USER_ID --json
|
|
68
68
|
shuffl logout --company
|
|
69
69
|
```
|
|
70
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
|
|
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.ai/docs/api-permissions#company-keys).
|
|
72
72
|
|
|
73
|
-
Full guide: [Use the Shuffl CLI](https://shuffl
|
|
73
|
+
Full guide: [Use the Shuffl CLI](https://shuffl.ai/docs/cli).
|
|
74
74
|
|
|
75
75
|
## License
|
|
76
76
|
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"dependencies": {
|
|
3
3
|
"@orpc/client": "1.15.3",
|
|
4
|
-
"@shuffl/api-contracts": "0.7.
|
|
5
|
-
"@shuffl/sdk": "0.7.
|
|
4
|
+
"@shuffl/api-contracts": "0.7.7",
|
|
5
|
+
"@shuffl/sdk": "0.7.7"
|
|
6
6
|
},
|
|
7
7
|
"description": "Shuffl command line: every public API operation as a scriptable command with JSON output.",
|
|
8
8
|
"engines": {
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"LICENSE",
|
|
20
20
|
"README.md"
|
|
21
21
|
],
|
|
22
|
-
"homepage": "https://shuffl
|
|
22
|
+
"homepage": "https://shuffl.ai/docs/sdk",
|
|
23
23
|
"keywords": [
|
|
24
24
|
"shuffl",
|
|
25
25
|
"cli",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"sideEffects": false,
|
|
34
34
|
"type": "module",
|
|
35
35
|
"types": "./dist/index.d.ts",
|
|
36
|
-
"version": "0.7.
|
|
36
|
+
"version": "0.7.7",
|
|
37
37
|
"bin": {
|
|
38
38
|
"shuffl": "./dist/bin.js"
|
|
39
39
|
}
|