Skip to content

Conversation

@GauravJangra9988
Copy link
Contributor

@GauravJangra9988 GauravJangra9988 commented Oct 5, 2025

Description

Added CLI commands usage

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [x ] Documentation update
  • Code refactoring
  • Performance improvement
  • Other (please describe):

Related Issue

Fixes #(issue number)
#48

Changes Made

  • Added CLI command usage
  • Removed API key env setup

Testing

  • Tested with Gemini API
  • Tested with Grok API
  • [x ] Tested on Windows
  • Tested on Linux
  • Tested on macOS
  • Added/updated tests (if applicable)

Checklist

  • My code follows the project's code style
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have tested this in a real Git repository
  • [x ] I have read the CONTRIBUTING.md guidelines

Screenshots (if applicable)

Additional Notes


For Hacktoberfest Participants

  • [x ] This PR is submitted as part of Hacktoberfest 2025

Thank you for your contribution! 🎉

Summary by CodeRabbit

  • Documentation
    • Rewrote README to use a CLI-driven LLM setup and API key management workflow.
    • Added step-by-step guides, screenshots, and examples for Setup, Update, Delete, Set Default, and Change API Key flows.
    • Consolidated LLM configuration into a unified Set/Update/Delete flow and updated installation/usage guidance.
    • Removed legacy environment-variable tables and OS-specific setup instructions.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 5, 2025

Walkthrough

Updates README to replace environment-variable LLM configuration with a CLI-driven flow using commit llm setup and commit llm update; removes OS-specific env var instructions and the environment variables table; adds unified Set/Update/Delete LLM configuration docs, examples, and new screenshots.

Changes

Cohort / File(s) Summary of changes
Docs: LLM setup via CLI
README.md
Replaces environment-variable guidance with CLI commands for LLM setup/update; removes env-var table and Windows/Linux blocks; adds "Setup LLM and API Key" and "Update LLM" sections, example blocks, new screenshots, and reorganizes content around Set/Update/Delete LLM configuration options.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant CLI as "commit CLI"
  participant Store as "LLM Config Store"
  participant Provider as "LLM Provider"

  rect rgba(200,240,255,0.25)
    note right of CLI: New setup flow
    User->>CLI: commit llm setup
    CLI-->>User: Prompt for provider and API key
    CLI->>Store: Save provider + key
    Store-->>CLI: Saved confirmation
    CLI-->>User: Setup complete
  end

  rect rgba(220,255,220,0.25)
    note right of CLI: Update / Delete flow
    User->>CLI: commit llm update
    CLI->>Store: Load current settings
    CLI-->>User: Present options (set default / change key / delete)
    alt change or set
      CLI->>Store: Update settings
      Store-->>CLI: Updated
      CLI-->>User: Update complete
    else delete
      CLI->>Store: Remove settings
      Store-->>CLI: Deleted
      CLI-->>User: Deletion complete
    end
  end

  note over CLI,Provider: Subsequent commands read stored config to call provider APIs
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • Cli interface #46 — Adds CLI commands and local store (SetupLLM/UpdateLLM, store.go, root.go) that implement the commit LLM configuration flow referenced in this README change.
  • Dev #18 — Previously added OpenAI env-var guidance and assets to the README; touches the same documentation area now replaced by CLI-driven instructions.
  • docs: Add documentation for Claude LLM provider #27 — Adds CLAUDE_API_KEY documentation; overlaps with prior environment-variable docs removed in this update.

Suggested reviewers

  • DFanso

Poem

I thump the keys with gentle glee,
New CLI paths for L-L-Ms and me.
No env maze, no tangled thread—
Just "setup" hops and "update" spread.
A carrot cursor blinks — config saved, ahead! 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly conveys that the README was updated for the new CLI, matching the documentation changes to add CLI commands and remove environment-variable setup instructions.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
README.md (1)

165-178: Replace bold pseudo-headings with real headings

Lines 165-178 use bold text to mimic headings, which trips MD036 and hurts document structure. Promote these to proper Markdown headings.

-**Set LLM as default**
+#### Set LLM as default
@@
-**Change API Key**
+#### Change API Key
@@
-**Delete LLM**
+#### Delete LLM
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between add80cf and 29a7fa6.

📒 Files selected for processing (1)
  • README.md (3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md

165-165: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


170-170: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


175-175: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

@DFanso DFanso added documentation Improvements or additions to documentation hacktoberfest Eligible for Hacktoberfest hacktoberfest-accepted Approved Hacktoberfest contribution labels Oct 5, 2025
@DFanso DFanso linked an issue Oct 5, 2025 that may be closed by this pull request
Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
README.md (1)

165-178: Promote these labels to real headings

markdownlint flags MD036 here because bold text is standing in for headings. Converting them to proper Markdown headings keeps the document structured and avoids lint failures. A quick fix:

-**Set LLM as default**
+#### Set LLM as default
 ```bash
 Select: Set Default

-Change API Key
+#### Change API Key

Select: Change API Key

-Delete LLM
+#### Delete LLM

Select: Delete

Based on static analysis hints.

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: CodeRabbit UI

**Review profile**: CHILL

**Plan**: Pro

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 29a7fa6761498c0f4761ec82152944338f99c934 and 925554d952f385173d8070d7e0e01072bcc9dcfb.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `README.md` (3 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>

<details>
<summary>README.md</summary>

165-165: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

170-170: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

175-175: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

</details>

</details>

</details>

<details>
<summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)</summary>

* GitHub Check: Build Go Binary (windows-latest)

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Copy link
Owner

@DFanso DFanso left a comment

Choose a reason for hiding this comment

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

LGTM 🎉

@DFanso DFanso merged commit 961cd50 into DFanso:main Oct 6, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation hacktoberfest Eligible for Hacktoberfest hacktoberfest-accepted Approved Hacktoberfest contribution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Update doc about CLI commands

2 participants