@revturbine/cli 0.1.1
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/LICENSE +21 -0
- package/README.md +65 -0
- package/dist/cli.js +5527 -0
- package/package.json +44 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 RevTurbine
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# revturbine-cli (`revturbine`)
|
|
2
|
+
|
|
3
|
+
Verify [RevTurbine](https://www.revturbine.com) **ExportedConfig** files and ship
|
|
4
|
+
them to a RevTurbine instance through the Change Set lifecycle — from the
|
|
5
|
+
terminal, the same operations the in-app Pre-Sales Agent performs.
|
|
6
|
+
|
|
7
|
+
`revturbine` is the command-line counterpart to the RevTurbine control plane. It
|
|
8
|
+
schema-validates a config offline, authenticates to an instance via the browser
|
|
9
|
+
(RFC 8628 device flow), and stages / deploys configs as Change Sets so every
|
|
10
|
+
change is reviewable and rollback-able.
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm i -g @revturbine/cli # global `revturbine` binary
|
|
16
|
+
# or run without installing:
|
|
17
|
+
npx @revturbine/cli --help
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
The published npm package is `@revturbine/cli`; the installed command is
|
|
21
|
+
`revturbine`.
|
|
22
|
+
|
|
23
|
+
Requires Node ≥ 20.
|
|
24
|
+
|
|
25
|
+
## Quick start
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
revturbine verify ./export-config.json # schema-validate locally (no network)
|
|
29
|
+
revturbine login # authorize this machine (device flow)
|
|
30
|
+
revturbine diff ./export-config.json # dry-run: live config vs local, no writes
|
|
31
|
+
revturbine upload ./export-config.json # stage as a draft Change Set
|
|
32
|
+
revturbine deploy <change-set-id> # submit → approve → deploy (go live)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
`revturbine <command> --help` documents every flag.
|
|
36
|
+
|
|
37
|
+
## Commands
|
|
38
|
+
|
|
39
|
+
| Command | What it does |
|
|
40
|
+
|---|---|
|
|
41
|
+
| `login` / `logout` | Device-flow auth; tokens stored at `~/.revturbine/credentials.json` (mode 0600). |
|
|
42
|
+
| `verify` | Schema-validate a config offline against the bundled schema. |
|
|
43
|
+
| `diff` | Non-destructive: download the live config, diff against local, dry-run the import. |
|
|
44
|
+
| `upload` | Stage a config as a draft Change Set (`--deploy` to also activate). |
|
|
45
|
+
| `deploy` | Activate a staged draft: submit → approve → deploy. |
|
|
46
|
+
| `validate` | Run config-validation against a staged draft. |
|
|
47
|
+
| `export` | Download the live config (stdout, or `--save`). |
|
|
48
|
+
| `status` | Show the active draft and recent releases. |
|
|
49
|
+
| `discard` / `rollback` | Archive an open draft / revert a deployed change set. |
|
|
50
|
+
| `evaluate` | Run the live config's placement/entitlement decisions for a user context. |
|
|
51
|
+
| `preview` | Runtime-impact preview of a draft change set. |
|
|
52
|
+
| `promote` | Promote a compiled config from one environment to another. |
|
|
53
|
+
|
|
54
|
+
## Schema validation
|
|
55
|
+
|
|
56
|
+
Validation is **mandatory** and runs fully offline against a vendored,
|
|
57
|
+
version-stamped snapshot of RevTurbine's `ExportedConfigSchema`
|
|
58
|
+
(`src/schema/`, regenerated from the canonical schema via
|
|
59
|
+
`npm run generate:schema`). The CLI never uploads a config it could not
|
|
60
|
+
validate. `revturbine --version` reports both the CLI version and the schema
|
|
61
|
+
snapshot version.
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
MIT — see [LICENSE](./LICENSE).
|