chore: updated readme
This commit is contained in:
1 parent
430875f200
commit
d9b85e3598
1 file changed
+39
-11
@@ -1,16 +1,31 @@
|
|||||||
# lazysecrets
|
# lazysecrets
|
||||||
|
|
||||||
A terminal UI for finding, reading and sharing secrets, inspired by lazygit.
|
A terminal UI for finding, reading and sharing secrets. Inspired by the fantastic lazygit.
|
||||||
One place for:
|
|
||||||
|
|
||||||
- **Azure Key Vault**: secrets, keys and certificates, across every az account
|
## Main features
|
||||||
- **Databricks** secret scopes
|
|
||||||
- **SOPS and `.env` files** in your git repos
|
|
||||||
|
|
||||||
It reads with your existing logins (az, Databricks CLI, sops), never stores
|
- **Zero setup**: uses the logins you already have (`az`, the Databricks
|
||||||
values, and gives every item a `lazysecrets://` link a colleague can open.
|
CLI, `sops`, `git`). No config file needed.
|
||||||
|
- **Search everything**: `ctrl+s` searches every source at once, with
|
||||||
|
fzf-style matching (`'exact`, `^prefix`, `suffix$`, `!not`), and jumps
|
||||||
|
straight to the result.
|
||||||
|
- **Share links**: `s` copies a `lazysecrets://` link. A colleague opens it
|
||||||
|
with their own access, from the terminal or with a click in the browser
|
||||||
|
or chat.
|
||||||
|
- **Careful with values**: values stay hidden until you reveal them, and
|
||||||
|
copied values are cleared from the clipboard after 30 seconds.
|
||||||
|
- **Scriptable**: `lazysecrets get <link>` prints a value for scripts and
|
||||||
|
pipes.
|
||||||
|
- **Favourites**: star the secrets you use most and get back to them in one
|
||||||
|
key.
|
||||||
|
- **Expiry warnings**: secrets, keys and certificates that expire soon are
|
||||||
|
marked.
|
||||||
|
- **Your way**: rebind any key, pick a theme, and add custom commands to run
|
||||||
|
on a secret.
|
||||||
|
- **Try it first**: `lazysecrets --demo` runs on built-in sample data.
|
||||||
|
- **Supported platforms**: Azure Key Vault, Databricks secret scopes, and SOPS and `.env` files in your git repos.
|
||||||
|
|
||||||
Status: early development. See [CHANGELOG.md](CHANGELOG.md) for what's new.
|
> Early development: expect rough edges. See [CHANGELOG.md](CHANGELOG.md) for what's new.
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
@@ -25,6 +40,7 @@ into `~/.local/bin` after checking it against the release's checksums.
|
|||||||
`sh -s -- v0.2.0` installs a given version, `LAZYSECRETS_INSTALL_DIR`
|
`sh -s -- v0.2.0` installs a given version, `LAZYSECRETS_INSTALL_DIR`
|
||||||
somewhere else.
|
somewhere else.
|
||||||
|
|
||||||
|
|
||||||
lazysecrets looks for a newer release once a day: the footer then shows
|
lazysecrets looks for a newer release once a day: the footer then shows
|
||||||
`↑ v0.2.0`, and `U` shows its changelog and updates in place (or run
|
`↑ v0.2.0`, and `U` shows its changelog and updates in place (or run
|
||||||
`lazysecrets update`).
|
`lazysecrets update`).
|
||||||
@@ -35,9 +51,9 @@ Or build it yourself:
|
|||||||
## Get started
|
## Get started
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
az login # once, if you use Azure; lazysecrets reuses it
|
az login # login with azure cli
|
||||||
lazysecrets # inside a repo, it opens on that repo's secret files
|
lazysecrets # start lazysecrets
|
||||||
lazysecrets --demo # built-in sample data, nothing to sign in to
|
lazysecrets --demo # test with demo data
|
||||||
```
|
```
|
||||||
|
|
||||||
Pick a source on the left, then a vault, then a secret. The keys you'll
|
Pick a source on the left, then a vault, then a secret. The keys you'll
|
||||||
@@ -70,6 +86,18 @@ use most:
|
|||||||
- [Development](docs/development.md): building, tests, pull requests and
|
- [Development](docs/development.md): building, tests, pull requests and
|
||||||
releasing
|
releasing
|
||||||
|
|
||||||
|
## Privacy
|
||||||
|
|
||||||
|
lazysecrets never stores, caches or sends your secret values. It talks only
|
||||||
|
to the services you use it with, and collects no usage data. The one call
|
||||||
|
of its own is a daily check for a new release on this server, which
|
||||||
|
`updateCheck: false` turns off.
|
||||||
|
|
||||||
|
|
||||||
|
## AI disclosure
|
||||||
|
|
||||||
|
Built with help from an agentic coding assistant. Every change is requested, reviewed and tested by me before it's merged.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Copyright © 2026 Karl-Einar Bergstrøm.
|
Copyright © 2026 Karl-Einar Bergstrøm.
|
||||||
|
|||||||
Reference in new issue
Block a user