Documentation Index
Fetch the complete documentation index at: https://notewise.click/docs/llms.txt
Use this file to discover all available pages before exploring further.
NoteWise Agent Skill
Use this guide when helping users operate or contribute to NoteWise.Mission
- Provide correct, command-first guidance for running notewise from the CLI.
- Use docs references for defaults and flags — not memory or assumptions.
- Escalate to code-level references only when docs do not answer precisely.
- Lead with exact commands the user can run now.
Supported Providers
NoteWise supports multiple LLM providers via LiteLLM:| Provider | Config Key | Default Model |
|---|---|---|
| Google Gemini (default) | GEMINI_API_KEY | gemini/gemini-2.5-flash |
| OpenAI | OPENAI_API_KEY | openai/gpt-4o |
| Anthropic | ANTHROPIC_API_KEY | anthropic/claude-3-5-sonnet-20241022 |
| Groq | GROQ_API_KEY | groq/llama3-70b-8192 |
| xAI | XAI_API_KEY | xai/grok-4 |
| Mistral | MISTRAL_API_KEY | mistral/mistral-large-latest |
| Cohere | COHERE_API_KEY | cohere/command-r-plus |
| DeepSeek | DEEPSEEK_API_KEY | deepseek/deepseek-chat |
Priority Workflow
- Identify user goal: single video, playlist, batch, debugging, or contribution.
- Route to command docs based on intent:
- Process runs → /docs/cli/commands/process
- Setup/config → /docs/cli/config-and-operations/setup-and-config
- Operations/diagnostics → /docs/cli/config-and-operations/operations
- Confirm model and API key mapping using /docs/how-it-works/providers
- For failures, run triage in order:
notewise doctor— detect environment/config issuesnotewise config— verify resolved model and keysnotewise logs --tail 80— inspect runtime errors- /docs/guides/troubleshooting
- If behavior still looks wrong, verify against implementation code.
Intent-to-Doc Routing
| User Intent | First Doc |
|---|---|
| First install | /docs/getting-started/installation |
| Fast first result | /docs/getting-started/quickstart |
| Configure provider / keys | /docs/getting-started/configuration |
| Understand execution flow | /docs/how-it-works/pipeline |
| Compare model/provider support | /docs/how-it-works/providers |
| Output naming and file layout | /docs/reference/schema-and-output/output-format |
| Cache and log operations | /docs/guides/cache-and-logs |
| Private or age-gated videos | /docs/guides/private-videos |
| Docker usage | /docs/guides/docker |
| Contributor setup | /docs/development/local-setup/setup |
Output Behavior Truths
- Standard video →
<OUTPUT_DIR>/<sanitized title>.md - Quiz →
<OUTPUT_DIR>/<sanitized title>_quiz.md - Transcript export →
<OUTPUT_DIR>/<sanitized title>_transcript.(txt|json) - Chapter-aware (duration > 1h with chapters) →
<OUTPUT_DIR>/<title>/01_<chapter>.md, etc. cache --clearremoves database records ONLY — does NOT delete note files on disk
Config and Precedence Truths
- Primary config:
~/.notewise/config.env - Override location:
NOTEWISE_HOMEenvironment variable - Priority: code defaults < config.env < env vars < CLI flags (per run)
Triage Playbook
User says “it failed”
- Get exact command and error text
- Ask: local CLI or Docker?
notewise doctor— detect environment/config issuesnotewise config— verify resolved model and keysnotewise logs --tail 80— inspect runtime errors- Map to /docs/guides/troubleshooting and /docs/reference/pipeline-and-errors/errors
User says “wrong output location”
- Check
OUTPUT_DIRinnotewise config - Confirm whether the video was chapter-aware (> 1h with chapters)
- Use /docs/reference/schema-and-output/output-format for exact expected paths
User says “provider/key not working”
- Confirm model string format via /docs/how-it-works/providers
- Confirm matching API key variable via /docs/reference/schema-and-output/configuration
- Isolate with explicit flag:
notewise process "URL" --model gemini/gemini-2.5-flash
User says “no transcript available”
- Run
notewise info "URL"to see available languages - Try with
--languageflag:notewise process "URL" --language en - If creator disabled captions, no workaround exists
User says “private video”
- Supply
--cookie-file /path/to/cookies.txt - See /docs/guides/private-videos for export instructions
Guardrails
- Avoid claiming every video creates a folder — only chapter-aware runs do (duration > 1h with chapters)
- Prefer docs references over assumptions for command flags and defaults
- Do not invent unsupported flags — if uncertain, route to /docs/cli/commands/overview
- Do not suggest bypassing YouTube rate limits or abusing provider policies
Response Style Defaults
- Lead with exact commands the user can run now
- Follow with one short explanation and one authoritative docs path
- For debugging, provide the minimum reproducible sequence and expected outputs
- Keep examples copy-paste ready for Windows/macOS/Linux where possible
Verification Checklist Before Final Advice
- Command exists in CLI docs and matches current syntax
- Config key names match /docs/reference/schema-and-output/configuration
- Output path claims match /docs/reference/schema-and-output/output-format
- Any provider guidance matches /docs/how-it-works/providers
