@isaacthoman/pulpo 0.44.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 +41 -0
- package/dist/index.js +16020 -0
- package/package.json +45 -0
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Pulpo CLI
|
|
2
|
+
|
|
3
|
+
Operator-first command-line client for a Pulpo instance.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install --global @isaacthoman/pulpo
|
|
7
|
+
pulpo context add production --url https://pulpo.example.com
|
|
8
|
+
pulpo auth login --email admin@example.com
|
|
9
|
+
pulpo settings export --output pulpo-settings.json
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Use `pulpo help` or `pulpo <command> --help` for the complete command reference.
|
|
13
|
+
|
|
14
|
+
The major command groups are `context`, `auth`, `token`, `instance`, `settings`,
|
|
15
|
+
`provider`, `lab`, `model`, `user`, `usage`, `audit`, `workspace`, `banner`,
|
|
16
|
+
`job`, `export`, and `backup`. There is intentionally no restore command.
|
|
17
|
+
|
|
18
|
+
Human-readable tables are the default. `--json` reserves stdout for stable JSON;
|
|
19
|
+
errors remain on stderr, and noninteractive destructive commands require
|
|
20
|
+
`--yes`. Add `--verbose` to print method, path, status, and timing diagnostics
|
|
21
|
+
without printing authorization headers or request bodies.
|
|
22
|
+
|
|
23
|
+
Configuration precedence is command-line options, then `PULPO_CONTEXT` /
|
|
24
|
+
`PULPO_URL` / `PULPO_TOKEN`, then the current stored context. Context metadata
|
|
25
|
+
lives in the platform config directory. Session tokens use Keychain on macOS or
|
|
26
|
+
Secret Service on Linux when available, with a mode-`0600` file and warning as
|
|
27
|
+
the fallback. Passwords are read from a hidden prompt, stdin, or
|
|
28
|
+
`PULPO_PASSWORD`; no secret-bearing password/token option is accepted.
|
|
29
|
+
|
|
30
|
+
Settings exports use `apiVersion: pulpo.dev/management/v1` and carry an opaque
|
|
31
|
+
revision. `settings diff` exits with status 2 when changes exist. A stale
|
|
32
|
+
`settings apply` fails rather than overwriting a newer change. Use a marker such
|
|
33
|
+
as `{ "fromEnv": "KAGI_API_KEY" }` for a secret replacement or
|
|
34
|
+
`{ "clear": true }` to remove it.
|
|
35
|
+
|
|
36
|
+
Management token scopes are `account:read`, `account:write`, `instance:read`,
|
|
37
|
+
`instance:write`, `catalog:read`, `catalog:write`, `users:read`, `users:write`,
|
|
38
|
+
`usage:read`, `audit:read`, `operations:read`, and `operations:write`.
|
|
39
|
+
Administrator scopes continue to require the token owner's current administrator
|
|
40
|
+
role. Tokens are shown only once when created and only work below
|
|
41
|
+
`/api/management/v1`.
|