@ratelkey/cli 1.1.0 → 1.2.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 +15 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# RatelKey CLI
|
|
2
2
|
|
|
3
|
-
`ratel`
|
|
4
|
-
|
|
5
|
-
A Burrow is a secrets manager you host. This CLI is how a machine joins one and how scripts on that machine read what they are allowed to read.
|
|
3
|
+
`ratel` enrolls machines into a [RatelKey](https://ratelkey.com) Burrow and reads secrets from it.
|
|
6
4
|
|
|
7
5
|
## Install
|
|
8
6
|
|
|
@@ -10,7 +8,7 @@ A Burrow is a secrets manager you host. This CLI is how a machine joins one and
|
|
|
10
8
|
npm install -g @ratelkey/cli
|
|
11
9
|
```
|
|
12
10
|
|
|
13
|
-
|
|
11
|
+
npm installs the binary for your platform: Linux (x64, arm64, arm), macOS (x64, Apple silicon), and Windows (x64, arm64).
|
|
14
12
|
|
|
15
13
|
To run it once without installing:
|
|
16
14
|
|
|
@@ -18,7 +16,7 @@ To run it once without installing:
|
|
|
18
16
|
npx @ratelkey/cli <command>
|
|
19
17
|
```
|
|
20
18
|
|
|
21
|
-
##
|
|
19
|
+
## Enroll a machine
|
|
22
20
|
|
|
23
21
|
On your Burrow's **Machines** page, click the **(+)** in the table header, name the machine, and choose **Create token**. Run the command it gives you on the machine you are enrolling:
|
|
24
22
|
|
|
@@ -28,9 +26,7 @@ npx @ratelkey/cli machine bootstrap <code>
|
|
|
28
26
|
|
|
29
27
|
Where the Burrow is reachable from more than one address, the dialog shows a command for **On your network** and one for **Outside your network**. Use the one that matches where the machine sits.
|
|
30
28
|
|
|
31
|
-
The
|
|
32
|
-
|
|
33
|
-
The token is one-time and enrols a single machine.
|
|
29
|
+
The token is one-time and enrolls a single machine.
|
|
34
30
|
|
|
35
31
|
```
|
|
36
32
|
Registered web-01 to my-burrow.
|
|
@@ -71,11 +67,21 @@ Passing a field name selects one field directly:
|
|
|
71
67
|
ratel secret get myapp/prod/STRIPE publishable_key
|
|
72
68
|
```
|
|
73
69
|
|
|
70
|
+
## OIDC
|
|
71
|
+
|
|
72
|
+
```sh
|
|
73
|
+
ratel auth use oidc --burrow https://burrow.example.com --fingerprint <fp>
|
|
74
|
+
ratel secret get myapp/prod/DATABASE_URL
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
`--audience` defaults to the burrow URL. `--fingerprint` is omitted when the burrow serves a publicly-trusted certificate. `ratel auth use ed25519` switches back. GitHub Actions currently requires `permissions: id-token: write`.
|
|
78
|
+
|
|
74
79
|
## Commands
|
|
75
80
|
|
|
76
81
|
| Command | What it does |
|
|
77
82
|
| --- | --- |
|
|
78
|
-
| `ratel machine bootstrap <code>` |
|
|
83
|
+
| `ratel machine bootstrap <code>` | Enroll this machine into a Burrow |
|
|
84
|
+
| `ratel auth use <ed25519\|oidc>` | Choose how this machine authenticates (default: ed25519) |
|
|
79
85
|
| `ratel secret get <project/env/NAME \| NAME> [field]` | Read a secret's current value |
|
|
80
86
|
| `ratel secret list` | List every secret this machine can read, by slug |
|
|
81
87
|
| `ratel project list` | List the projects this machine can read, and its access in each |
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name":"@ratelkey/cli","version":"1.
|
|
1
|
+
{"name":"@ratelkey/cli","version":"1.2.0","description":"RatelKey CLI — enrol machines into a Burrow and read its secrets","keywords":["secrets","vault","encryption","cli","ratelkey","burrow","self-hosted"],"homepage":"https://ratelkey.com","repository":{"type":"git","url":"git+https://github.com/RatelKeyOrg/ratel-cli.git"},"bugs":{"url":"https://github.com/RatelKeyOrg/ratel-cli/issues"},"license":"MIT","bin":{"ratel":"bin/ratel"},"files":["bin"],"optionalDependencies":{"@ratelkey/cli-darwin-arm64":"1.2.0","@ratelkey/cli-darwin-x64":"1.2.0","@ratelkey/cli-linux-arm":"1.2.0","@ratelkey/cli-linux-arm64":"1.2.0","@ratelkey/cli-linux-x64":"1.2.0","@ratelkey/cli-win32-arm64":"1.2.0","@ratelkey/cli-win32-x64":"1.2.0"}}
|