Skip to content

fix: clarify invalid config JSON errors #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nightcityblade wants to merge 6 commits into
base: main
Choose a base branch
from
+2,271 −71
Open

fix: clarify invalid config JSON errors #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
964865e
fix: clarify invalid config JSON errors
Jun 6, 2026
70fe4ff
feat: add streaming support for commit suggestions (#114)
404-Page-Found Jun 6, 2026
9948b2f
test: fix Windows fixtures (#117)
Peter7896 Jun 6, 2026
83d5d6a
test: cover auto alias parity (#120)
Peter7896 Jun 6, 2026
b100500
feat: add interactive multi-repo batch mode (#121)
404-Page-Found Jun 6, 2026
cc8b374
test: isolate config-store env overrides on Windows
Jun 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,15 @@ Suggestions generated:
3. chore: refresh package metadata
```

### Stream suggestions as they are generated

Use `--stream` to print LLM output incrementally instead of waiting behind a spinner. Supported for OpenAI-compatible and Anthropic providers; use non-streaming mode for Cohere. Pair with `--yes` for a non-interactive workflow that streams output and auto-commits the first suggestion.

```bash
commit-echo suggest --stream
commit-echo suggest --stream --yes
```
Comment on lines +190 to +195
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Jun 6, 2026

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

commit-echo suggest --stream --yes does not auto-commit without --commit.

The new wording/examples say this combo auto-commits, but in the current CLI flow suggest only commits when --commit is set. Please update the text/example to avoid misleading users.

Suggested doc fix 
-Use `--stream` to print LLM output incrementally instead of waiting behind a spinner. Supported for OpenAI-compatible and Anthropic providers; use non-streaming mode for Cohere. Pair with `--yes` for a non-interactive workflow that streams output and auto-commits the first suggestion.
+Use `--stream` to print LLM output incrementally instead of waiting behind a spinner. Supported for OpenAI-compatible and Anthropic providers; use non-streaming mode for Cohere. Pair with `--yes` for non-interactive selection, and add `--commit` if you also want auto-commit.
 
 ```bash
 commit-echo suggest --stream
-commit-echo suggest --stream --yes
+commit-echo suggest --stream --yes --commit
</details>

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **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.

```suggestion
Use `--stream` to print LLM output incrementally instead of waiting behind a spinner. Supported for OpenAI-compatible and Anthropic providers; use non-streaming mode for Cohere. Pair with `--yes` for non-interactive selection, and add `--commit` if you also want auto-commit.
🤖 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 `@README.md` around lines 190 - 195, The README incorrectly states that
"commit-echo suggest --stream --yes" will auto-commit; update the docs/examples
to require the actual commit flag by changing the example and wording to include
"--commit" (i.e., use "commit-echo suggest --stream --yes --commit") and clarify
in the sentence that suggest only performs a commit when the --commit flag is
present; reference the CLI command "suggest" and flags "--stream", "--yes", and
"--commit" when making the edit.


### Inspect suggestion diagnostics with `--verbose`

Use verbose mode when you want to confirm which model handled the request, how much commit history was folded into the style profile, or whether the diff had to be truncated before sending it to the provider.
Expand Down
Loading