diff --git a/README.md b/README.md index 1f91d5b..ba2fc7b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,31 @@ # lazysecrets -A terminal UI for finding, reading and sharing secrets, inspired by lazygit. -One place for: +A terminal UI for finding, reading and sharing secrets. Inspired by the fantastic lazygit. -- **Azure Key Vault**: secrets, keys and certificates, across every az account -- **Databricks** secret scopes -- **SOPS and `.env` files** in your git repos +## Main features -It reads with your existing logins (az, Databricks CLI, sops), never stores -values, and gives every item a `lazysecrets://` link a colleague can open. +- **Zero setup**: uses the logins you already have (`az`, the Databricks + 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 ` 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 @@ -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` somewhere else. + 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 `lazysecrets update`). @@ -35,9 +51,9 @@ Or build it yourself: ## Get started ```sh -az login # once, if you use Azure; lazysecrets reuses it -lazysecrets # inside a repo, it opens on that repo's secret files -lazysecrets --demo # built-in sample data, nothing to sign in to +az login # login with azure cli +lazysecrets # start lazysecrets +lazysecrets --demo # test with demo data ``` 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 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 Copyright © 2026 Karl-Einar Bergstrøm.