Skip to main content

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 keeps operational state local. The default state root is ~/.notewise, or NOTEWISE_HOME when set.

SQLite schema

The cache DB is <state>/.notewise_cache.db. Schema version is 2.
TablePurpose
videoCached video identity, title, duration, and cache time.
transcriptTranscript content and language per video.
runstatsTokens, cost, model, transcript time, generation time, and timestamp.
exportrecordFormat and output path for exported artifacts.
schema_versionHand-rolled migration version.

Logs

Logs are written under <state>/logs as notewise-YYYY-MM-DD_HH-MM-SS.log. The format is structlog key-value text, not JSON.

Pipeline events

The UI dashboard reads typed pipeline events from domain/events.py.
PhaseEvents
Pipelinepipeline_start, pipeline_complete
Metadatametadata_start, metadata_fetched
Transcripttranscript_fetching, transcript_fetched
Notesgeneration_start, chunk_generating, generation_combining, generation_complete
Chapterschapter_generating, chapter_chunk_generating, chapter_combining, chapter_complete
Quizquiz_generating, quiz_chunk_generating, quiz_combining, quiz_complete
Video resultvideo_success, video_skipped, video_failed
Event payloads can include video ID, title, chapter/chunk counts, phase label, error text, and output path.

Error model

All custom exceptions live in src/notewise/errors.py and derive from NoteWiseError. User-facing categories include configuration, validation, YouTube extraction, transcript availability, playlist extraction, IP blocking, LLM generation, OAuth, persistence, and update failures. Use notewise doctor, notewise info URL, and notewise logs --tail 100 before debugging source code.
Last modified on May 1, 2026