@scrt-link/cli 0.0.1 → 0.0.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 +65 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# @scrt-link/cli
|
|
2
|
+
|
|
3
|
+
CLI for [scrt.link](https://scrt.link) — create end-to-end encrypted, self-destructing secrets from the command line.
|
|
4
|
+
|
|
5
|
+
[scrt.link](https://scrt.link) is a secure secret-sharing platform. Secrets are encrypted on the client before being sent to the server. The server never sees the plaintext. Once viewed (or expired), secrets are permanently deleted.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g @scrt-link/cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Or run without installing:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx @scrt-link/cli "my secret"
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# Set your API key once (or pass --api-key per command)
|
|
23
|
+
export SCRT_LINK_API_KEY=ak_...
|
|
24
|
+
|
|
25
|
+
# Basic — prints the secret link to stdout
|
|
26
|
+
scrtlink "super-secret-password"
|
|
27
|
+
|
|
28
|
+
# With options
|
|
29
|
+
scrtlink "https://example.com" \
|
|
30
|
+
--type redirect \
|
|
31
|
+
--expires 1h \
|
|
32
|
+
--views 5 \
|
|
33
|
+
--note "Bitcoin wallet" \
|
|
34
|
+
--password "unlock123"
|
|
35
|
+
|
|
36
|
+
# Self-hosted / white-label instance
|
|
37
|
+
scrtlink "my secret" --host br3f.com
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Options
|
|
41
|
+
|
|
42
|
+
| Flag | Description | Default |
|
|
43
|
+
| ------------ | --------------------------------- | ----------- |
|
|
44
|
+
| `--type` | `text` \| `redirect` \| `neogram` | `text` |
|
|
45
|
+
| `--expires` | `1h` \| `1d` \| `1w` \| `1m` | `1w` |
|
|
46
|
+
| `--views` | View limit 1–1000 | `1` |
|
|
47
|
+
| `--note` | Public note shown before reveal | — |
|
|
48
|
+
| `--password` | Password-protect the secret | — |
|
|
49
|
+
| `--host` | Override API host (self-hosted) | `scrt.link` |
|
|
50
|
+
| `--api-key` | API key (overrides env var) | — |
|
|
51
|
+
|
|
52
|
+
The command prints the secret link to stdout, making it pipeable:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
scrtlink "my secret" | pbcopy
|
|
56
|
+
echo "my secret" | xargs scrtlink
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## API Key
|
|
60
|
+
|
|
61
|
+
Get your API key on [scrt.link](https://scrt.link) under Account → API. API access requires a paid plan.
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
MIT
|