@captainsafia/burrow 1.0.0 → 1.2.0-preview.12cf29c
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 +17 -0
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
Burrow is a platform-agnostic, directory-scoped secrets manager. Secrets are stored outside your repos in a local SQLite store and exportable to various formats via the CLI. For a nicer dev experience, Burrow currently stores secrets in a plain-text format outside the target repo, which means that secrets can still be leaked to other users on your machine or people who gain access to your device. But, for your day-to-day dev use, this beats keeping secrets in gitignored files in your repo.
|
|
4
4
|
|
|
5
|
+
<p align="center">
|
|
6
|
+
<img src="demo.gif" alt="burrow demo" width="600">
|
|
7
|
+
</p>
|
|
8
|
+
|
|
5
9
|
```
|
|
6
10
|
~/projects/ # DATABASE_URL, API_KEY defined here
|
|
7
11
|
├── app-a/ # inherits both secrets
|
|
@@ -23,7 +27,16 @@ curl -fsSL https://safia.rocks/burrow/install.sh | sh
|
|
|
23
27
|
### Set a secret
|
|
24
28
|
|
|
25
29
|
```bash
|
|
30
|
+
# KEY=VALUE format
|
|
26
31
|
burrow set API_KEY=sk-live-abc123
|
|
32
|
+
|
|
33
|
+
# KEY VALUE format (separate arguments)
|
|
34
|
+
burrow set API_KEY sk-live-abc123
|
|
35
|
+
|
|
36
|
+
# KEY only (prompts for value)
|
|
37
|
+
burrow set API_KEY
|
|
38
|
+
|
|
39
|
+
# With a specific path
|
|
27
40
|
burrow set DATABASE_URL=postgres://localhost/mydb --path ~/projects
|
|
28
41
|
```
|
|
29
42
|
|
|
@@ -32,6 +45,8 @@ burrow set DATABASE_URL=postgres://localhost/mydb --path ~/projects
|
|
|
32
45
|
```bash
|
|
33
46
|
burrow get API_KEY
|
|
34
47
|
burrow get API_KEY --format json
|
|
48
|
+
# Redact the secret value in output
|
|
49
|
+
burrow get API_KEY --redact
|
|
35
50
|
```
|
|
36
51
|
|
|
37
52
|
### List all secrets
|
|
@@ -39,6 +54,8 @@ burrow get API_KEY --format json
|
|
|
39
54
|
```bash
|
|
40
55
|
burrow list
|
|
41
56
|
burrow list --format json
|
|
57
|
+
# Redact secret values in output
|
|
58
|
+
burrow list --redact
|
|
42
59
|
```
|
|
43
60
|
|
|
44
61
|
### Export to your shell
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@captainsafia/burrow",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.2.0-preview.12cf29c",
|
|
4
4
|
"description": "Platform-agnostic, directory-scoped secrets manager",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/api.js",
|
|
@@ -51,6 +51,8 @@
|
|
|
51
51
|
],
|
|
52
52
|
"license": "MIT",
|
|
53
53
|
"dependencies": {
|
|
54
|
-
"
|
|
54
|
+
"clipboardy": "^5.0.2",
|
|
55
|
+
"commander": "^14.0.2",
|
|
56
|
+
"gh-release-update-notifier": "^1.0.0"
|
|
55
57
|
}
|
|
56
58
|
}
|