Skip to content

versioning, update docs - #2

Merged
mvoutov merged 1 commit into
mainfrom
docs-release
Mar 18, 2026
Merged

versioning, update docs#2
mvoutov merged 1 commit into
mainfrom
docs-release

Conversation

@mvoutov

@mvoutov mvoutov commented Mar 18, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • New Features

    • New --model flag to select Claude model (Sonnet, Opus, Haiku)
    • Auto-scaling timeout based on repository size
    • Token usage summary after generation
    • Repository size estimation in scan output
    • New customize agents command to tailor installed agents to your project
    • 9 bundled agents with 2 hooks and 2 slash commands
  • Documentation

    • Enhanced CLI documentation with expanded command examples and options

@coderabbitai

coderabbitai Bot commented Mar 18, 2026

Copy link
Copy Markdown

Walkthrough

Version release 0.1.0 updates package metadata, CLI version strings, and documentation. Introduces --model flag, auto-scaling timeout, bundled agents, hooks, slash commands, and test suite. No functional code changes present.

Changes

Cohort / File(s) Summary
Documentation
CHANGELOG.md, README.md
Version header and changelog entries updated to 0.1.0. README expanded with --model flag documentation, new "aspens customize agents" command section, bundled library details, and examples for all add workflow operations.
Configuration & Version
bin/cli.js, package.json
Version bumped from 0.0.1 to 0.1.0 in CLI welcome message and package metadata. Added "files" array to package.json declaring distributable directories.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'versioning, update docs' directly reflects the main changes: version bump to 0.1.0 and comprehensive documentation updates across CHANGELOG, README, and CLI.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-release
📝 Coding Plan
  • Generate coding plan for human review comments

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CHANGELOG.md`:
- Line 15: Update the user-facing CHANGELOG entry for the `--verbose` flag so
the compound adjective is hyphenated: change the phrase "`--verbose` mode to see
Claude's exploration in real time" to use "real-time" (e.g., "`--verbose` mode
to see Claude's exploration in real-time") to fix grammar and maintain
consistency.

In `@README.md`:
- Around line 146-149: The README documents an unsupported flag (--force) for
the aspens add command; either remove the row or implement the flag in the add
command handler. To implement: locate the CLI registration/handler for the "add"
command (the function that registers the "add" command or the addCommand/add
handler) and add a boolean option/flag named "--force" (or force) to the command
parser, surface it to the handler, and use it when creating files to skip
prompts/allow overwriting existing files (i.e., if force is true, overwrite
without confirmation; otherwise preserve current behavior). Ensure help text
matches README and update any tests or docs accordingly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: da4f1df3-3f50-43de-8799-0a558b07c494

📥 Commits

Reviewing files that changed from the base of the PR and between baca5f8 and de92c97.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (4)
  • CHANGELOG.md
  • README.md
  • bin/cli.js
  • package.json

Comment thread CHANGELOG.md
- Verbose mode (`--verbose`) to see Claude's exploration in real time
- Auto-scaling timeout based on repo size
- `--model` flag for choosing Claude model (sonnet, opus, haiku)
- `--verbose` mode to see Claude's exploration in real time

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

Use “real-time” as a compound adjective.

Small wording fix for consistency and grammar in user-facing docs.

✏️ Suggested doc fix
-- `--verbose` mode to see Claude's exploration in real time
+- `--verbose` mode to see Claude's exploration in real-time
📝 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
- `--verbose` mode to see Claude's exploration in real time
- `--verbose` mode to see Claude's exploration in real-time
🧰 Tools
🪛 LanguageTool

[uncategorized] ~15-~15: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...se` mode to see Claude's exploration in real time - Token usage summary after generation ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` at line 15, Update the user-facing CHANGELOG entry for the
`--verbose` flag so the compound adjective is hyphenated: change the phrase
"`--verbose` mode to see Claude's exploration in real time" to use "real-time"
(e.g., "`--verbose` mode to see Claude's exploration in real-time") to fix
grammar and maintain consistency.

Comment thread README.md
Comment on lines +146 to +149
| Option | Description |
|--------|-------------|
| `--list` | Browse available components |
| `--force` | Overwrite existing files |

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

aspens add --force is documented but not implemented in CLI.

README lists --force for aspens add, but the command currently exposes only --list. Please either remove this row or add the option in add command implementation.

📘 Minimal README-only fix
 | Option | Description |
 |--------|-------------|
 | `--list` | Browse available components |
-| `--force` | Overwrite existing files |
📝 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
| Option | Description |
|--------|-------------|
| `--list` | Browse available components |
| `--force` | Overwrite existing files |
| Option | Description |
|--------|-------------|
| `--list` | Browse available components |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 146 - 149, The README documents an unsupported flag
(--force) for the aspens add command; either remove the row or implement the
flag in the add command handler. To implement: locate the CLI
registration/handler for the "add" command (the function that registers the
"add" command or the addCommand/add handler) and add a boolean option/flag named
"--force" (or force) to the command parser, surface it to the handler, and use
it when creating files to skip prompts/allow overwriting existing files (i.e.,
if force is true, overwrite without confirmation; otherwise preserve current
behavior). Ensure help text matches README and update any tests or docs
accordingly.

@mvoutov
mvoutov merged commit 9226a88 into main Mar 18, 2026
2 checks passed
@mvoutov
mvoutov deleted the docs-release branch March 18, 2026 22:57
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