diff --git a/CHANGELOG.md b/CHANGELOG.md index 69e6a28..5b2eff2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,18 @@ All notable changes to this project will be documented in this file. -## [0.4.0] - 2024-05-27 +## [0.4.2] - 2024-05-27 + +### 🐛 Bug Fixes + +- *(delete)* Move up the path when deleting the last entry +- Add set_selected_item helper + +### ⚙️ Miscellaneous Tasks + +- *(ci)* Add create-release need + +## [0.4.1] - 2024-05-27 ### 🚀 Features @@ -21,5 +32,6 @@ All notable changes to this project will be documented in this file. - Better messages - Add CI - Add dependencies for ubuntu +- *(ci)* Add cache and release to crates.io diff --git a/Cargo.lock b/Cargo.lock index 9633251..690e76c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -590,7 +590,7 @@ dependencies = [ [[package]] name = "vaultwalker" -version = "0.4.2" +version = "0.4.3" dependencies = [ "clipboard", "crossterm", diff --git a/Cargo.toml b/Cargo.toml index ddcabac..951927c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "vaultwalker" -version = "0.4.2" +version = "0.4.3" authors = ["Pierre Millot "] license = "MIT" description = "A CLI tool to browse Hashicorp Vault secrets" diff --git a/README.md b/README.md index 80e2a78..f44c8c9 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ vw -h ## Features -Navigate with the arrow to select any credentials, then use `P` to copy the path to the secret, or `S` to copy the secret itself. +Navigate with the arrow to select any credentials (or HJKL), then use `P` to copy the path to the secret, or `S` to copy the secret itself. To add a new key: - Navigate to the correct path and press `A` @@ -50,10 +50,24 @@ To delete a key: - Select the key you want to delete and press `D` - Enter `yes` to confirm, then `Enter` +To rename a key: +- Select the key you want to rename and press `R` +- Write the new name of the key, press `Enter` + +To quit the program press `Q` or `Ctrl+C`. +You can also press `C` to clear the cache refresh the current path. +To view the list of options at any time, press `O`. + ## Development -Run with `cargo run secret/my_company`. +Clone the repository and run `cargo run secret/my_company`. ### Publishing -`cargo publish` +The changelog is generated with [git-cliff](https://git-cliff.org/), to update it run `git-cliff` and commit the changes. +Before publishing, follow these steps: +- Update the version in `Cargo.toml` +- Push your final commit `git push` +- Check that the CI is passing; +- Create a new tag with the version number `git tag 0.1.0` +- Push the tag `git push --tags`