Update CLI non-interactive mode instructions#297
Conversation
Added instructions for re-running CLI non-interactively by deleting or renaming the ~/.akeyless directory.
📝 WalkthroughWalkthroughThis PR updates the CLI documentation to clarify how users can re-run ChangesCLI Documentation - Re-initialization Guidance
Estimated Code Review Effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/Integrations` & Plugins/cli/index.md:
- Line 195: Edit the sentence that follows the CLI non-interactive example
("./akeyless --init") to add the missing article ("the ~/.akeyless directory")
and make the path platform-specific: keep the Unix shorthand "~/.akeyless" for
macOS/Linux and add the Windows equivalent (e.g., "%USERPROFILE%\\.akeyless" or
"C:\\Users\\<your-username>\\.akeyless") or a short note like "on Windows, check
%USERPROFILE%\\.akeyless", so the line around "./akeyless --init" and the
"~/.akeyless" reference is updated for clarity and cross-platform accuracy.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e9ccbd9b-41ef-446f-bd34-9b4a53a013c4
📒 Files selected for processing (1)
docs/Integrations & Plugins/cli/index.md
| ### Non-Interactive Mode | ||
|
|
||
| To initiate the CLI non-interactively, run `./akeyless --init`. This command works only the first time you run the CLI in that environment. | ||
| To initiate the CLI non-interactively, run `./akeyless --init`. This command works only the first time you run the CLI in that environment. To re-run the command, delete ~/.akeyless directory or rename it. |
There was a problem hiding this comment.
Add missing article and consider platform-specific paths.
The sentence "delete /.akeyless directory" is missing the article "the" before "/.akeyless directory". Additionally, the tilde path notation (~/.akeyless) is specific to Unix/Linux/macOS systems. Since this documentation covers Windows installations as well (as shown in the Windows section above), Windows users may be unclear about the equivalent path.
📝 Proposed fixes
Option 1 (minimal fix): Add the missing article
-To initiate the CLI non-interactively, run `./akeyless --init`. This command works only the first time you run the CLI in that environment. To re-run the command, delete ~/.akeyless directory or rename it.
+To initiate the CLI non-interactively, run `./akeyless --init`. This command works only the first time you run the CLI in that environment. To re-run the command, delete the ~/.akeyless directory or rename it.Option 2 (recommended): Add article and clarify platform-specific paths
-To initiate the CLI non-interactively, run `./akeyless --init`. This command works only the first time you run the CLI in that environment. To re-run the command, delete ~/.akeyless directory or rename it.
+To initiate the CLI non-interactively, run `./akeyless --init`. This command works only the first time you run the CLI in that environment. To re-run the command, delete or rename the configuration directory: `~/.akeyless` on Linux/macOS or `%USERPROFILE%\.akeyless` on Windows.As per coding guidelines: "Language in documentation must be clear, concise, active-voice, and neutral in tone" and "Examples and commands in documentation must be realistic and internally consistent."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| To initiate the CLI non-interactively, run `./akeyless --init`. This command works only the first time you run the CLI in that environment. To re-run the command, delete ~/.akeyless directory or rename it. | |
| To initiate the CLI non-interactively, run `./akeyless --init`. This command works only the first time you run the CLI in that environment. To re-run the command, delete or rename the configuration directory: `~/.akeyless` on Linux/macOS or `%USERPROFILE%\.akeyless` on Windows. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/Integrations` & Plugins/cli/index.md at line 195, Edit the sentence that
follows the CLI non-interactive example ("./akeyless --init") to add the missing
article ("the ~/.akeyless directory") and make the path platform-specific: keep
the Unix shorthand "~/.akeyless" for macOS/Linux and add the Windows equivalent
(e.g., "%USERPROFILE%\\.akeyless" or "C:\\Users\\<your-username>\\.akeyless") or
a short note like "on Windows, check %USERPROFILE%\\.akeyless", so the line
around "./akeyless --init" and the "~/.akeyless" reference is updated for
clarity and cross-platform accuracy.
Added instructions for re-running CLI non-interactively by deleting or renaming the ~/.akeyless directory.
Summary
Validation
Safety Checklist
<service-account-name>@<project-id>.iam.gserviceaccount.com,arn:aws:iam::<aws-account-id>:root,<azure-tenant-id>, and<resource-ocid>).Jira
Summary by CodeRabbit