@revturbine/cli 0.16.1 → 0.16.3
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 +10 -10
- package/dist/cli.js +607 -395
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# revturbine-cli (`revturbine`)
|
|
2
2
|
|
|
3
|
-
Validate [RevTurbine](https://revturbine.com) **
|
|
3
|
+
Validate [RevTurbine](https://revturbine.com) **Playbooks** and ship them to
|
|
4
4
|
a RevTurbine instance through the playbook-version lifecycle (draft → Release) —
|
|
5
5
|
from the terminal, the same operations the in-app studios perform.
|
|
6
6
|
|
|
@@ -39,11 +39,11 @@ Requires Node ≥ 22.13. Source builds use the npm 11.18.0 version declared in
|
|
|
39
39
|
```bash
|
|
40
40
|
revturbine signup # create an account (email + password + emailed code)
|
|
41
41
|
revturbine login # authorize this machine (device flow)
|
|
42
|
-
revturbine download --live --save ./
|
|
43
|
-
# …edit ./
|
|
44
|
-
revturbine validate ./
|
|
45
|
-
revturbine diff ./
|
|
46
|
-
revturbine launch ./
|
|
42
|
+
revturbine download --live --save ./revturbine.playbook.json
|
|
43
|
+
# …edit ./revturbine.playbook.json…
|
|
44
|
+
revturbine validate ./revturbine.playbook.json # schema-validate locally (no network)
|
|
45
|
+
revturbine diff ./revturbine.playbook.json --live # what would change (no writes)
|
|
46
|
+
revturbine launch ./revturbine.playbook.json # upload, gate, and go live
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
`revturbine <command> --help` documents every flag.
|
|
@@ -54,7 +54,7 @@ Commands that read a config name the version explicitly — there is no default:
|
|
|
54
54
|
|
|
55
55
|
| Selector | Meaning |
|
|
56
56
|
|---|---|
|
|
57
|
-
| `<file>` / `--file <path>` | a local
|
|
57
|
+
| `<file>` / `--file <path>` | a local Playbook file |
|
|
58
58
|
| `--draft` | the tenant's single open draft (resolved automatically) |
|
|
59
59
|
| `--live` | the current live Release |
|
|
60
60
|
| `--release <id>` | a specific playbook version / Release |
|
|
@@ -71,9 +71,9 @@ Commands that read a config name the version explicitly — there is no default:
|
|
|
71
71
|
| `docs` | Print the canonical documentation URL. |
|
|
72
72
|
| `download` | Fetch a config version (`--live` / `--draft` / `--release <id>`); `--save`, `--format flatbuffer`. |
|
|
73
73
|
| `validate` | Offline schema validation of a `<file>`, or the full server catalog against the open draft (`--draft`). |
|
|
74
|
-
| `diff` | Compare any two versions
|
|
74
|
+
| `diff` | Compare any two versions (dry-run, no writes). A file vs `--draft`/`--live`/`--release` previews the launch — the server side is the base, so `+`/`-` read as created/pruned on launch. |
|
|
75
75
|
| `show <kind>` | Summary tables: `plans` · `entitlements` · `segments` · `placements` · `trials` for any version. |
|
|
76
|
-
| `upload` | Stage a
|
|
76
|
+
| `upload` | Stage a Playbook file as the open draft. |
|
|
77
77
|
| `launch` | Take a config live: validate (launch gate) → submit → approve → deploy. `launch <file>` or `launch --draft`. |
|
|
78
78
|
| `discard` | Archive the open draft (`--yes`). |
|
|
79
79
|
| `restore` | Stage a draft that restores a past release from its frozen snapshot; `--launch` takes it live. Halts if a draft is open. |
|
|
@@ -81,7 +81,7 @@ Commands that read a config name the version explicitly — there is no default:
|
|
|
81
81
|
| `history` | The Release Version Log, newest first. |
|
|
82
82
|
| `preview` | The open draft's staged changes. |
|
|
83
83
|
| `evaluate` | Run the live config's placement/entitlement decisions for a user context. |
|
|
84
|
-
| `generate types` | Generate a TypeScript module of
|
|
84
|
+
| `generate types` | Generate a TypeScript module of typed Playbook handles from any config version — `Entitlements` (namespaced by type, with the `EntitlementHandle` union for type-safe `can()`/`gate()`/`checkEntitlement()` call sites), plus `Plans`, `Segments`, `SurfaceTemplates`, and `UiPathActionTypes`. Const objects + literal-union types (erasable — no enums). `--out <path>` writes the file; the generated header records the exact command to regenerate it. `--json` for the raw handle map. |
|
|
85
85
|
|
|
86
86
|
`--json` on read commands emits machine-readable output. Results go to stdout,
|
|
87
87
|
diagnostics to stderr.
|