@litehex/vault-cli - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

dist/index.js

@@ -463,3 +463,3 @@ #!/usr/bin/env node
 });
-var remove = new Command4().command("rm <secrets-path>").description("Remove a secret from Vault").argument("[versions...]", "Versions to remove. By default, all versions will be removed.", []).option("-P, --profile <name>", "name of the profile to use.").option("--endpoint-url <endpoint-url>", "Vault endpoint URL").option("--token <vault-token>", "Vault token").option("--force", "Remove the secret without confirmation", false).action(async (vaultPath, versions, opts) => {
+var remove = new Command4().command("rm <secrets-path>").description("Remove a secret from Vault").argument("[versions...]", "Versions to remove. By default, path will be removed.", []).option("-P, --profile <name>", "Name of the profile to use").option("--endpoint-url <endpoint-url>", "Vault endpoint URL").option("--token <vault-token>", "Vault token").option("--force", "Remove the secret without confirmation", false).action(async (vaultPath, versions, opts) => {
   logger_default.log("");
@@ -466,0 +466,0 @@ try {

package.json

 {
   "name": "@litehex/vault-cli",
-  "description": "CLI for HashiCorp's Vault KV Engine",
-  "version": "0.1.1",
+  "description": "CLI for HashiCorp's Vault kv2 engine",
+  "version": "0.1.2",
   "scripts": {
@@ -6,0 +6,0 @@ "dev": "tsup --watch",

README.md

@@ -58,3 +58,3 @@ # Vault CLI
 Options:
-  -P, --profile <name>           name of the profile to use.
+  -P, --profile <name>           Name of the profile to use.
   --endpoint-url <endpoint-url>  Vault endpoint URL
@@ -71,6 +71,6 @@ --token <vault-token>          Vault token
 # Push a .env.local file to Vault
-vault push --profile my-profile .env.local secret/data/my-app
+vault push --profile my-profile .env.local secret/my-app
 
 # Use credentials instead of a profile
-vault push --endpoint-url https://vault.example.com --token my-token .env.local secret/data/my-app
+vault push --endpoint-url https://vault.example.com --token my-token .env.local secret/my-app
 ```
@@ -90,3 +90,3 @@
 Options:
-  -P, --profile <name>           name of the profile to use.
+  -P, --profile <name>           Name of the profile to use.
   --endpoint-url <endpoint-url>  Vault endpoint URL
@@ -105,10 +105,43 @@ --token <vault-token>          Vault token
 # Pull a secret from Vault
-vault pull --profile my-profile secret/data/my-app
+vault pull --profile my-profile secret/my-app
 
 # Pull a secret from Vault and save it to a .env file
-vault pull --profile my-profile secret/data/my-app --env-path .env
+vault pull --profile my-profile secret/my-app --env-path .env
 ```
 
+### rm
+
+This command will remove a path or some versions of a secret.
+
+#### Options
+
+```txt
+Usage: vault rm [options] <secrets-path> [versions...]
+
+Remove a secret from Vault
+
+Arguments:
+  secrets-path
+  versions                       Versions to remove. By default, path will be removed (default: [])
+
+Options:
+  -P, --profile <name>           Name of the profile to use
+  --endpoint-url <endpoint-url>  Vault endpoint URL
+  --token <vault-token>          Vault token
+  --force                        Remove the secret without confirmation (default: false)
+  -h, --help                     display help for command
+```
+
+#### Examples
+
+```bash
+# Remove a path secret from Vault
+vault rm --profile my-profile secret/my-app
+
+# Remove a secret version from Vault
+vault rm --profile my-profile secret/my-app 3 4
+```
+
 ### License
 
 This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

90368

increased by0.87%

Number of lines in readme file

144

increased by29.73%

No dependency changes