vaulter-cli 0.1.0 → 0.1.2
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 +59 -0
- package/package.json +10 -2
- package/postinstall.js +14 -1
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# vaulter-cli
|
|
2
|
+
|
|
3
|
+
Command-line tool for [Vaulter](https://vaulter-nine.vercel.app) — a secure API key manager. Store, list, and manage your API keys from the terminal.
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
╦ ╦╔═╗╦ ╦╦ ╔╦╗╔═╗╦═╗
|
|
7
|
+
╚╗╔╝╠═╣║ ║║ ║ ║╣ ╠╦╝
|
|
8
|
+
╚╝ ╩ ╩╚═╝╩═╝╩ ╚═╝╩╚═
|
|
9
|
+
Your keys. Your vault.
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install -g vaulter-cli
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Quick Start
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
# Authenticate via browser
|
|
22
|
+
vaulter sign-in
|
|
23
|
+
|
|
24
|
+
# List your keys
|
|
25
|
+
vaulter ls
|
|
26
|
+
|
|
27
|
+
# Add a new key
|
|
28
|
+
vaulter add my-openai-key
|
|
29
|
+
|
|
30
|
+
# Remove a key
|
|
31
|
+
vaulter remove my-openai-key
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Commands
|
|
35
|
+
|
|
36
|
+
| Command | Description |
|
|
37
|
+
| --- | --- |
|
|
38
|
+
| `vaulter sign-in` | Authenticate with Vaulter via browser |
|
|
39
|
+
| `vaulter ls` | List all API keys in your vault |
|
|
40
|
+
| `vaulter add <name>` | Add a new API key to your vault |
|
|
41
|
+
| `vaulter remove <name-or-id>` | Remove an API key from your vault |
|
|
42
|
+
| `vaulter web-app` | Open the Vaulter web app in your browser |
|
|
43
|
+
| `vaulter help` | Show all available commands |
|
|
44
|
+
|
|
45
|
+
## Authentication
|
|
46
|
+
|
|
47
|
+
Vaulter uses browser-based device auth. Running `vaulter sign-in` opens your browser where you log in, and the CLI receives a token automatically. Credentials are stored locally at `~/.vaulter/credentials.json` with restricted file permissions.
|
|
48
|
+
|
|
49
|
+
## Configuration
|
|
50
|
+
|
|
51
|
+
By default the CLI connects to `https://vaulter-nine.vercel.app`. You can override this with the `VAULTER_API_URL` environment variable:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
export VAULTER_API_URL=http://localhost:3000
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "vaulter-cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "CLI tool for Vaulter - Secure API Key Manager",
|
|
5
5
|
"author": "faris-sait",
|
|
6
6
|
"repository": {
|
|
@@ -18,7 +18,15 @@
|
|
|
18
18
|
"scripts": {
|
|
19
19
|
"postinstall": "node postinstall.js"
|
|
20
20
|
},
|
|
21
|
-
"keywords": [
|
|
21
|
+
"keywords": [
|
|
22
|
+
"vaulter",
|
|
23
|
+
"api-keys",
|
|
24
|
+
"cli",
|
|
25
|
+
"vault",
|
|
26
|
+
"security",
|
|
27
|
+
"env",
|
|
28
|
+
"secrets"
|
|
29
|
+
],
|
|
22
30
|
"license": "MIT",
|
|
23
31
|
"dependencies": {
|
|
24
32
|
"chalk": "^5.3.0",
|
package/postinstall.js
CHANGED
|
@@ -5,11 +5,24 @@ const purple3 = '\x1b[38;2;102;0;204m';
|
|
|
5
5
|
const purple4 = '\x1b[38;2;94;0;255m';
|
|
6
6
|
const reset = '\x1b[0m';
|
|
7
7
|
|
|
8
|
+
const dim = '\x1b[2m';
|
|
9
|
+
const bold = '\x1b[1m';
|
|
10
|
+
const white = '\x1b[37m';
|
|
11
|
+
|
|
8
12
|
console.log('');
|
|
9
13
|
console.log(purple + ' ╦ ╦╔═╗╦ ╦╦ ╔╦╗╔═╗╦═╗' + reset);
|
|
10
14
|
console.log(purple2 + ' ╚╗╔╝╠═╣║ ║║ ║ ║╣ ╠╦╝' + reset);
|
|
11
15
|
console.log(purple3 + ' ╚╝ ╩ ╩╚═╝╩═╝╩ ╚═╝╩╚═' + reset);
|
|
12
16
|
console.log(purple4 + ' Your keys. Your vault.' + reset);
|
|
13
17
|
console.log('');
|
|
14
|
-
console.log('
|
|
18
|
+
console.log(purple + ' COMMANDS' + reset);
|
|
19
|
+
console.log('');
|
|
20
|
+
console.log(' ' + bold + white + 'vaulter sign-in ' + reset + dim + 'Authenticate with Vaulter via browser' + reset);
|
|
21
|
+
console.log(' ' + bold + white + 'vaulter ls ' + reset + dim + 'List all API keys in your vault' + reset);
|
|
22
|
+
console.log(' ' + bold + white + 'vaulter add <name> ' + reset + dim + 'Add a new API key to your vault' + reset);
|
|
23
|
+
console.log(' ' + bold + white + 'vaulter remove <name-or-id>' + reset + dim + ' Remove an API key from your vault' + reset);
|
|
24
|
+
console.log(' ' + bold + white + 'vaulter web-app ' + reset + dim + 'Open the Vaulter web app in your browser' + reset);
|
|
25
|
+
console.log(' ' + bold + white + 'vaulter help ' + reset + dim + 'Show all available commands' + reset);
|
|
26
|
+
console.log('');
|
|
27
|
+
console.log(' Run ' + bold + 'vaulter sign-in' + reset + ' to get started.');
|
|
15
28
|
console.log('');
|