Installation

Requirements

Python 3.10 or newer (3.10, 3.11, 3.12, and 3.13 are all tested in CI)
An API key for at least one supported LLM provider

Install

uv (recommended)
pipx
pip
Docker
Standalone binaries

uv installs notewise as an isolated global tool and makes the command available anywhere on your PATH:

uv tool install notewise

Upgrade:

uv tool upgrade notewise

uv tool install is the cleanest Python-based install for a global CLI. It keeps notewise isolated, manages Python versions automatically, and avoids virtualenv clutter.

pipx installs notewise as a globally available CLI while keeping its dependencies isolated:

pipx install notewise

Upgrade:

pipx upgrade notewise

If you want notewise available from any shell and prefer PyPI-based installs, pipx is the best fit after uv.

pip install notewise

Upgrade:

pip install --upgrade notewise

Plain pip install places the notewise executable in the current Python environment’s scripts directory. For a command that works globally without manual PATH work, prefer uv tool install notewise, pipx install notewise, or the standalone installer scripts below.

Pre-built images are published to the GitHub Container Registry on every release:

docker pull ghcr.io/whoisjayd/notewise:latest

Quick run:

docker run --rm \
  -e GEMINI_API_KEY="your_key_here" \
  -v "$(pwd)/output:/output" \
  ghcr.io/whoisjayd/notewise:latest \
  process "https://youtube.com/watch?v=VIDEO_ID" --no-ui

The container runs as a non-root user (appuser, uid 1001). Mount /output to access generated files from the host.

See the Docker guide for persistent cache, cookie files, and full environment variable reference.

Every tagged release publishes standalone binaries for Linux, macOS, and Windows in GitHub Releases.Download the archive for your platform, extract it, and run:

./notewise version

On Windows, run:

.\notewise.exe version

Standalone binaries are useful when you do not want to manage a Python environment locally. The installer scripts below also add the install directory to your PATH.

Installer scripts

Every release publishes install.sh and install.ps1 alongside the binaries and SHA256SUMS.txt.

install.sh installs to ~/.local/bin by default, appends that directory to your shell profile, and verifies the release checksum before installing.
install.ps1 installs to %LOCALAPPDATA%\Programs\NoteWise, updates the user PATH, and verifies the release checksum before installing.
Set NOTEWISE_INSTALL_DIR to override the install location in either script.

Examples:

curl -fsSL https://github.com/whoisjayd/notewise/releases/latest/download/install.sh | sh

irm https://github.com/whoisjayd/notewise/releases/latest/download/install.ps1 | iex

Verify

After installing, confirm notewise is on your PATH:

notewise version

Expected output:

notewise version 1.0.0

To check for a newer release later and see the right upgrade command for your install:

notewise update

Next steps

Quick Start

Run your first video in under 5 minutes.

Configuration

Set up your API key and config file.

Development setup

Clone, install dev dependencies, and run tests.

Docker guide

Full Docker usage with volumes and env vars.

Getting Started

How It Works

Guides

Requirements

Install

Installer scripts

Verify

Next steps

Quick Start

Configuration

Development setup

Docker guide

Getting Started

How It Works

Guides

​Requirements

​Install

​Installer scripts

​Verify

​Next steps

Quick Start

Configuration

Development setup

Docker guide

Requirements

Install

Installer scripts

Verify

Next steps