# NoteWise docs for LLMs

NoteWise is a Python CLI (`>=3.11`) that converts YouTube videos, playlists, and batch files into local study notes through LiteLLM providers. Current documented version: `1.6.0`.

Canonical public docs base: `https://notewise.click/docs`

Canonical routes:

- Overview: `/docs`
- Install: `/docs/start/install`
- Quickstart: `/docs/start/quickstart`
- Process videos: `/docs/use/process`
- Playlists and batches: `/docs/use/playlists-batches`
- Private videos and Docker: `/docs/use/private-docker`
- Configuration: `/docs/config/configuration`
- Models and providers: `/docs/config/providers`
- OAuth login: `/docs/config/oauth`
- CLI commands: `/docs/operate/commands`
- Cache, logs, history, stats: `/docs/operate/cache-logs-history`
- Troubleshooting: `/docs/operate/troubleshooting`
- Pipeline and output: `/docs/understand/pipeline-output`
- Storage, events, errors: `/docs/understand/storage-events`
- Website and docs: `/docs/understand/website-docs`
- Development: `/docs/understand/development`

Source truth:

- Default model: `gemini/gemini-2.5-flash`
- Default output directory: `./output`
- Default output format: `md`; supported formats: `md`, `html`, `pdf`, `docx`
- Temperature: `0.7`
- Max concurrent videos: `5`
- YouTube requests per minute: `10`
- Chunk size / overlap: `12000` / `1500`
- Max concurrent chapters: `3`

CLI commands:

- `process`, `setup`, `config`, `config-path`, `version`, `update`, `stats`, `history`, `info`, `doctor`, `edit-config`, `auth login`, `cache`, `logs`, `help`

Important `process` flags:

- `--model/-m`, `--output/-o`, `--format`, `--language/-l`, `--target-language`, `--temperature/-t`, `--max-tokens/-k`, `--throttle`, `--force/-F`, `--no-ui`, `--verbose/-v`, `--quiz`, `--export-transcript`, `--timestamps`, `--chapter-directory-output`, `--cookie-file/--cookies`

Config truth:

- Config file: `~/.notewise/config.db`
- `NOTEWISE_HOME` changes the state root.
- Practical precedence: CLI flags, then environment variables, then config file, then defaults.
- Common keys: `DEFAULT_MODEL`, `CUSTOM_LLM_ENDPOINTS`, `OUTPUT_DIR`, `MAX_CONCURRENT_VIDEOS`, `MAX_CONCURRENT_CHAPTERS`, `CHUNK_SIZE`, `CHUNK_OVERLAP`, `DEFAULT_LANGUAGES`, `YOUTUBE_REQUESTS_PER_MINUTE`, `TEMPERATURE`, `MAX_TOKENS`, `YOUTUBE_COOKIE_FILE`, provider API/auth keys.
- Saved custom endpoints use `<name>/<model-id>` and are managed with `notewise inference list|add|update|delete`; names cannot use LiteLLM provider prefixes, remote endpoints require HTTPS, and a changed `--base-url` requires `--api-key`. The compact `CUSTOM_LLM_ENDPOINTS` registry contains API keys and must stay masked.
- `CHUNK_OVERLAP` must be smaller than `CHUNK_SIZE`.

Provider truth:

- Gemini `GEMINI_API_KEY`
- OpenAI `OPENAI_API_KEY`
- Anthropic `ANTHROPIC_API_KEY`
- Groq `GROQ_API_KEY`
- xAI `XAI_API_KEY`
- Mistral `MISTRAL_API_KEY`
- Cohere `COHERE_API_KEY`
- DeepSeek `DEEPSEEK_API_KEY`
- OpenRouter `OPENROUTER_API_KEY`
- Azure `AZURE_API_KEY` or `AZURE_OPENAI_API_KEY`
- Vercel AI Gateway `VERCEL_AI_GATEWAY_API_KEY`
- Together `TOGETHERAI_API_KEY`
- Fireworks `FIREWORKS_AI_API_KEY`
- Perplexity `PERPLEXITYAI_API_KEY`
- Cloudflare needs `CLOUDFLARE_API_KEY` and `CLOUDFLARE_ACCOUNT_ID`
- Databricks needs `DATABRICKS_API_KEY` and `DATABRICKS_API_BASE`
- Bedrock uses the AWS credential chain
- AI21 `AI21_API_KEY`
- Cerebras `CEREBRAS_API_KEY`
- DashScope `DASHSCOPE_API_KEY`
- DeepInfra `DEEPINFRA_API_KEY`
- Hugging Face `HUGGINGFACE_API_KEY`
- Jina AI `JINA_API_KEY`
- Novita AI `NOVITA_API_KEY`
- NVIDIA NIM `NVIDIA_NIM_API_KEY`
- Replicate `REPLICATE_API_KEY`
- SambaNova `SAMBANOVA_API_KEY`
- Voyage AI `VOYAGE_API_KEY`

OAuth truth:

- ChatGPT login: `notewise auth login chatgpt`, safe model `chatgpt/gpt-5.6-luna`
- GitHub Copilot login: `notewise auth login github_copilot`, safe model `github_copilot/gpt-5-mini`
- `codex` is a CLI alias for ChatGPT login.
- Token dirs default under `<state>/oauth/...` unless `CHATGPT_TOKEN_DIR` or `GITHUB_COPILOT_TOKEN_DIR` is set.

Output truth:

- Cache check happens before metadata/transcript unless `--force` is used.
- Videos with YouTube chapters use chapter-aware generation.
- Chapter videos default to bundled notes; per-chapter folders require `--chapter-directory-output`.
- PDF uses fpdf2 with a bundled Noto Sans font (Latin, Cyrillic, Greek, Vietnamese, Devanagari); other scripts or renderer failures fall back to Markdown.
- `cache clear` deletes the SQLite DB and sidecars, not generated notes.
- Logs are structlog key-value text, not JSON.

Security guidance: never request or expose API keys, OAuth tokens, cookies, raw LLM prompts, or provider payloads.