Skip to main content

​
Requirements

  • Python 3.10 or newer — Python 3.10, 3.11, 3.12, and 3.13 are all tested in CI.
  • An API key for at least one supported LLM provider. The default model is Gemini 2.5 Flash; grab a free key at aistudio.google.com.

​
Install methods

uv tool install notewise
uv tool install and pipx install are the recommended choices when you want notewise available globally from anywhere on your system PATH. Plain pip install installs the CLI into the currently active Python environment only.

​
Standalone binary installer

Both the Unix shell script and the Windows PowerShell script verify SHA256SUMS.txt, install the release binary, and update your user-level PATH automatically — no Python installation required.

​
Docker

Run NoteWise in a container without installing anything on the host: 
docker run --rm \
  -e GEMINI_API_KEY="your_key" \
  -v "$(pwd)/output:/output" \
  ghcr.io/whoisjayd/notewise:latest \
  process "https://youtube.com/watch?v=VIDEO_ID"
Mount /output to access the generated Markdown files on the host filesystem. The container runs as a non-root user (uid 1001).

​
Development install

To contribute to NoteWise or run from source, clone the repository and use uv sync: 
git clone https://github.com/whoisjayd/notewise
cd notewise
uv sync --dev
This installs all runtime and development dependencies (pytest, ruff, bandit, ty, etc.) into an isolated virtual environment managed by uv.

​
Updating

To check whether a newer release is available and print the recommended upgrade command for your install method, run: 
notewise update
To upgrade manually, use the command that matches how you installed NoteWise: 
uv tool upgrade notewise

​
PATH setup

If you install via uv tool install or pipx install and the notewise command is not found, ensure that the tool bin directory is on your PATH:
  • uv: ~/.local/bin (Unix) or %APPDATA%\uv\bin (Windows)
  • pipx: ~/.local/bin (Unix) or %APPDATA%\Python\Scripts (Windows)
Both installers print a warning and the exact export command if your PATH needs updating.

Build docs developers (and LLMs) love

Get started for freeTalk to us