Skip to content

Update CLI non-interactive mode instructions#297

Open
zhuwbigdata wants to merge 1 commit into
akeylesslabs:v1.0from
zhuwbigdata:patch-1
Open

Update CLI non-interactive mode instructions#297
zhuwbigdata wants to merge 1 commit into
akeylesslabs:v1.0from
zhuwbigdata:patch-1

Conversation

@zhuwbigdata
Copy link
Copy Markdown

@zhuwbigdata zhuwbigdata commented May 29, 2026

Added instructions for re-running CLI non-interactively by deleting or renaming the ~/.akeyless directory.

Summary

Validation

  • markdownlint run for edited Markdown files
  • cspell run for edited Markdown files
  • link check run for edited Markdown files

Safety Checklist

  • No real credentials, tokens, account identifiers, tenant IDs, project numbers, or email addresses were added.
  • All cloud identities in examples use placeholders (for example, <service-account-name>@<project-id>.iam.gserviceaccount.com, arn:aws:iam::<aws-account-id>:root, <azure-tenant-id>, and <resource-ocid>).
  • Added examples were reviewed for sanitized values and non-production identifiers.

Jira

  • DOCS-

Summary by CodeRabbit

  • Documentation
    • Clarified CLI initialization instructions for non-interactive mode, including explicit steps to reinitialize the environment when needed.

Review Change Stack

Added instructions for re-running CLI non-interactively by deleting or renaming the ~/.akeyless directory.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2026

📝 Walkthrough

Walkthrough

This PR updates the CLI documentation to clarify how users can re-run ./akeyless --init in non-interactive mode by deleting or renaming the ~/.akeyless directory, building on the existing explanation that the command runs only on first use.

Changes

CLI Documentation - Re-initialization Guidance

Layer / File(s) Summary
Non-interactive mode re-initialization guidance
docs/Integrations & Plugins/cli/index.md
Added explicit instruction on how to re-run ./akeyless --init by deleting or renaming ~/.akeyless, clarifying the remediation path for users who need to reinitialize in non-interactive mode.

Estimated Code Review Effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A bunny's guide, one line so bright,
To akeyless --init made crystal clear,
Just delete that dot-directory tonight,
And reinit becomes perfectly dear! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and specifically describes the main change: updating CLI non-interactive mode instructions in the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 98bd81f and 8f3efdc.

📒 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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant