You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,7 @@ You can install `dotsec` using one of the following methods:
17
17
-[build from source](#build-from-source)
18
18
-[install via `crates.io`](#install-via-cratesio)
19
19
-[install via homebrew](#install-via-homebrew)
20
+
-[install via script (Linux Only)](#install-via-script)
20
21
21
22
🥅 Short-term goal: Publish on more package managers!
22
23
@@ -44,14 +45,25 @@ brew tap junhsonjb/dotsec
44
45
brew install dotsec
45
46
```
46
47
48
+
### Install via script
49
+
Use `curl` to download the installation script and execute it with `sh`:
50
+
```sh
51
+
curl -sSL https://raw.githubusercontent.com/junhsonjb/dotsec/main/distribution/install.sh | sh
52
+
```
53
+
> This script downloads the latest binary and installs it to /usr/local/bin/ds
54
+
55
+
It's always recommended to inspect scripts that you download off the internet before running them. You can do so by running the following:
56
+
```sh
57
+
curl -sSL https://raw.githubusercontent.com/junhsonjb/dotsec/main/distribution/install.sh | less
58
+
```
59
+
> Alternatively, [download the script directly](./distribution/install.sh)
60
+
47
61
## 🧠 Heads up
48
62
The CLI is in early development (`v0.1.x`) — expect rapid iteration and the occasional breaking change. Feedback welcome!
49
63
50
64
## 🔐 Security
51
65
`dotsec` uses [ChaCha20-Poly1305](https://github.com/RustCrypto/AEADs/tree/master/chacha20poly1305) to encrypt and decrypt secrets. Keys and values are stored locally on the user's machine using [sled](https://github.com/spacejam/sled).
52
66
53
-
⚠️ Encryption keys are stored at `$XDG_CONFIG_HOME/dotsec/private/dotsec.key` (`$XDG_CONFIG_HOME` resolves to `$HOME/.config` unless otherwise defined). **This file is not encrypted. Please do not publicize this file (on github or elsewhere)!**`dotsec`'s primary goal is to provide a safe place to store your CLI secrets. It is the user's responsibility to safely manage their encryption key.
54
-
55
67
> ⚠️ **Important: Encryption key is stored in plaintext!**
56
68
>
57
69
> The encryption key is saved to the following location:
0 commit comments