USER_DOCS

sparkle-cli docs (end users)

Back to main README

This folder contains end-user documentation organized by implemented feature.

Feature index

1. Install and first run
   • 01-install-and-first-run.md
2. Configuration file and overrides
   • 02-configuration.md
3. Slash commands (default + custom)
   • 03-slash-commands.md
4. Web search and semantic cache (Qdrant)
   • 04-search-and-semantic-cache.md
5. Source mode and sidebar Q&A
   • 05-source-mode-and-sidebar.md
6. Interaction modes (Normal, Reasoning, Chat)
   • 06-interaction-modes.md
7. Input editor, clipboard, and output acceptance
   • 07-editor-clipboard-and-output.md
8. Zsh widget integration (Ctrl+G)
   • 08-zsh-integration.md
9. Language and localization behavior
   • 09-language-and-localization.md
10. Detailed /search workflow diagram

• 10-search-workflow.md

Recommended reading order

1. 01-install-and-first-run.md
2. 02-configuration.md
3. 03-slash-commands.md
4. 04-search-and-semantic-cache.md
5. Then read the rest based on your workflow.