feat(cli): add multimodal flags clarification to loop set help (CLI-012)

[itz-PrathamMittal]

Pull Request

Description

Add clarification to loop mode's 'set help' command explaining that multimodal flags (--image, --pdf, --csv, --file) are per-command flags, not session variables.

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)
• [] 📚 Documentation update
• 🧹 Code refactoring (no functional changes)
• ⚡ Performance improvement
• 🧪 Test coverage improvement
• 🔧 Build/CI configuration change

Related Issues

Fixes #350

Changes Made

• Add note section after session variables list
• Include two examples of correct usage in loop mode
• Use consistent indentation (2 spaces for text, 4 for examples)
• Match existing chalk color scheme (cyan, gray, dim)

AI Provider Impact

• OpenAI
• Anthropic
• Google AI/Vertex
• AWS Bedrock
• Azure OpenAI
• Hugging Face
• Ollama
• Mistral
• All providers
• No provider-specific changes

Component Impact

• CLI
• SDK
• MCP Integration
• Streaming
• Tool Calling
• Configuration
• Documentation
• Tests

Testing

• Unit tests added/updated
• Integration tests added/updated
• E2E tests added/updated
• Manual testing performed
• All existing tests pass

Test Environment

• OS:
• Node.js version:
• Package manager:

Performance Impact

• No performance impact
• Performance improvement
• Minor performance impact (acceptable)
• Significant performance impact (needs discussion)

Breaking Changes

Screenshots/Demo

Checklist

• My code follows the project's style guidelines
• 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
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published

Additional Notes

Summary by CodeRabbit

• Documentation
  • Improved CLI help text: added informational notes clarifying that multimodal flags are per-command options (not session variables) and provided usage examples in two help locations to improve guidance during command usage.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Added two informational help messages clarifying that multimodal flags (--image, --pdf, --csv, --file) are per-command options (not session variables). Messages appear in the session start flow after schema display and inside the showSetHelp() output with examples.

Changes

Cohort / File(s)	Summary
Multimodal flags clarification notes src/cli/loop/session.ts	Inserted informational log/help text clarifying that multimodal flags are per-command (not session variables). Added note after schema display in session start flow and explanatory text with usage examples in showSetHelp() output.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify messaging accurately states "per-command" and matches linked issue acceptance criteria
• Confirm formatting (dim/consistent styling) aligns with existing help text
• Check correctness of usage examples and placement in both locations

Poem

🐰 I nibble on docs with a careful twitch,
Flags now per-command—no more glitch.
A hop, a hint, a tiny delight,
Users find clarity, morning to night. ✨

Pre-merge checks and finishing touches

✅ 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 accurately reflects the main change: adding multimodal flags clarification to loop set help with issue reference CLI-012.
Linked Issues check	✅ Passed	The PR addresses all acceptance criteria from issue #350: clarifying multimodal flags are per-command (not session variables), providing usage examples, ensuring consistent formatting, and passing all tests.
Out of Scope Changes check	✅ Passed	All changes are contained to src/cli/loop/session.ts and consist solely of informational notes related to multimodal flags clarification, directly addressing the linked issue with no extraneous modifications.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[itz-PrathamMittal]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[itz-PrathamMittal]

@copilot full review

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

[Copilot]

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.