NoteWise

https://github.com/whoisjayd/notewise
Admin
NoteWise is a Python CLI tool that converts YouTube videos and playlists into comprehensive...
Tokens:38,911
Snippets:722
Trust Score:7.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Setup Development Environment

Source: https://github.com/whoisjayd/notewise/blob/main/README.md

Commands to clone the repository, install dependencies, and run quality assurance tasks.

```bash
# Clone & install
git clone https://github.com/whoisjayd/notewise
cd notewise
uv sync --dev

# Run tests
make test

# Lint, format, type-check
make quality

# Full CI pipeline locally
make ci
```

--------------------------------

### Verify setup

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/local-setup/setup.mdx

Confirms the installation by checking the version and running unit tests.

```bash
uv run notewise version
uv run pytest tests/unit -q
```

--------------------------------

### Create yt-study runtime config

Source: https://github.com/whoisjayd/notewise/wiki/Installation

Run this command to initiate the setup wizard for yt-study. It will guide you through creating the necessary configuration file.

```bash
yt-study setup
```

--------------------------------

### Run Setup Wizard

Source: https://github.com/whoisjayd/notewise/wiki/Configuration

Commands to launch the interactive configuration setup wizard.

```bash
yt-study setup
yt-study setup --force
```

--------------------------------

### Initial Setup Wizard

Source: https://context7.com/whoisjayd/notewise/llms.txt

Run the interactive setup wizard to configure your LLM provider and API key. This creates the `~/.notewise/config.env` file. Use `--force` to re-run setup if a config already exists, or `--show` to display the current configuration.

```bash
notewise setup
```

```bash
notewise setup --force
```

```bash
notewise setup --show
```

--------------------------------

### Install dependencies using make sync

Source: https://github.com/whoisjayd/notewise/wiki/Installation

After cloning the repository, run this make command to synchronize and install all project dependencies. This requires `make` to be installed.

```bash
make sync
```

--------------------------------

### Mintlify CLI for Local Development

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/contributing/documentation.mdx

Commands to install the Mintlify CLI and start a local development server for previewing documentation changes.

```terminal
npm i -g mint
cd docs
mint dev
```

--------------------------------

### Install dependencies

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/local-setup/setup.mdx

Creates a virtual environment and installs all project dependencies.

```bash
uv sync --dev
```

--------------------------------

### Run Notewise Setup Wizard

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Initiates the interactive setup wizard for Notewise. Use `--force` to re-run even if config exists, or `--show` to display current config without setup.

```bash
notewise setup
```

```bash
notewise setup --force    # re-run even when config already exists
```

```bash
notewise setup --show     # display current config and exit
```

--------------------------------

### Install NoteWise CLI

Source: https://context7.com/whoisjayd/notewise/llms.txt

Install the NoteWise CLI using various package managers or standalone installers. Recommended to use uv for installation.

```bash
uv tool install notewise
```

```bash
pipx install notewise
```

```bash
pip install notewise
```

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

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

```bash
docker pull ghcr.io/whoisjayd/notewise:latest
```

--------------------------------

### Setup & Configuration Commands Overview

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

A quick map of common Notewise commands for setup, inspection, and editing configuration.

```APIDOC
## Quick Command Map

### First Run
- `notewise setup`
- `notewise config`
- `notewise process "https://youtube.com/watch?v=VIDEO_ID"`

### Inspect Config
- `notewise config`
- `notewise config-path`

### Edit & Verify
- `notewise edit-config`
- `notewise config`
```

--------------------------------

### notewise setup

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Run the interactive setup wizard to configure Notewise. It prompts for LLM provider and API key, then writes `~/.notewise/config.env`.

```APIDOC
## `notewise setup`

### Description
Run the interactive setup wizard. It uses a bundled LiteLLM model catalog for fast startup and falls back to live metadata only when needed. Prompts for your LLM provider and API key, then writes `~/.notewise/config.env`.

### Usage
```bash
notewise setup
notewise setup --force    # re-run even when config already exists
notewise setup --show     # display current config and exit
```

### Options
| Option | Description |
| --- | --- |
| `--force` / `-f` | Re-run wizard even when config already exists |
| `--show` | Display current config and exit |
```

--------------------------------

### Basic Usage Example

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/process.mdx

A simple example of processing a video by its URL.

```bash
# Basic
notewise process "https://youtube.com/watch?v=VIDEO_ID"
```

--------------------------------

### Initial Notewise Setup and Processing

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Use these commands for the first run of Notewise, including setup, initial configuration check, and processing a YouTube video.

```bash
notewise setup
```

```bash
notewise config
```

```bash
notewise process "https://youtube.com/watch?v=VIDEO_ID"
```

--------------------------------

### Example config.env file

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/configuration.mdx

A sample configuration file demonstrating various settings.

```bash
# ~/.notewise/config.env

DEFAULT_MODEL=gemini/gemini-2.5-flash
OUTPUT_DIR=~/study-notes
MAX_CONCURRENT_VIDEOS=3
TEMPERATURE=0.7
# MAX_TOKENS=2000

GEMINI_API_KEY=your_key_here
# OPENAI_API_KEY=sk-...
# ANTHROPIC_API_KEY=sk-ant-...
```

--------------------------------

### Common Setup Issues

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Troubleshooting common problems encountered during Notewise setup and configuration.

```APIDOC
## Common Setup Issues

### Setup says config already exists
Re-run with force:

```bash
notewise setup --force
```

### Need to verify which config file is active

```bash
notewise config-path
```

If `NOTEWISE_HOME` is set, notewise resolves config from that directory.

### API key looks set but calls still fail
Confirm model/key pairing in resolved config:

```bash
notewise config
```

Verify `DEFAULT_MODEL` and the matching provider API key are both present.
```

--------------------------------

### Clone and Install Dependencies

Source: https://github.com/whoisjayd/notewise/blob/main/CONTRIBUTING.md

Clone the repository and install all runtime and development dependencies using uv.

```bash
git clone https://github.com/whoisjayd/notewise
cd notewise
uv sync --dev
```

--------------------------------

### Example Session Output

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/index.mdx

This example demonstrates the typical output of a NoteWise session when processing a single video, showing progress and completion status.

```bash
$ notewise process "https://youtube.com/watch?v=dQw4w9WgXcQ"

 notewise  v1.0.0

Processing 1 video...

 Video Title
   ✔ Metadata fetched
   ✔ Transcript fetched  (en, 342 segments)
   ✔ Notes generated  (3 chunks)
   ✔ Written → output/Video Title.md

────────────────────────────────────────
  1 processed · 0 failed · 12.4s · $0.0004

```

--------------------------------

### Initialize Notewise Configuration

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/overview.mdx

Use the `setup` command to run the interactive wizard for creating the `~/.notewise/config.env` file.

```bash
notewise setup
```

--------------------------------

### Install Notewise with install.sh script

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/installation.mdx

Install Notewise using the provided shell script. This script installs to ~/.local/bin by default, appends it to your shell profile, and verifies the release checksum.

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

--------------------------------

### Install Notewise with pipx

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/installation.mdx

Use pipx to install Notewise as a globally available CLI while keeping its dependencies isolated. This is a good alternative if you prefer PyPI-based installs.

```bash
pipx install notewise
```

--------------------------------

### Re-run Setup Wizard with Force Option

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Use this command to re-run the Notewise setup wizard when configuration already exists.

```bash
notewise setup --force
```

--------------------------------

### Model String Format Examples

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/how-it-works/providers.mdx

Examples of how to specify LLM models, including provider prefixes and unambiguous model names.

```terminal
provider/model-name
```

```bash
gemini/gemini-2.5-flash
openai/gpt-4o
anthropic/claude-3-5-sonnet-20241022
groq/llama3-70b-8192
```

```bash
gpt-4o                        # routes to OpenAI
claude-3-5-sonnet-20241022    # routes to Anthropic
```

--------------------------------

### Install Notewise with install.ps1 script

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/installation.mdx

Install Notewise using the provided PowerShell script. This script installs to %LOCALAPPDATA%\Programs\NoteWise, updates the user PATH, and verifies the release checksum.

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

--------------------------------

### Example config.env File

Source: https://github.com/whoisjayd/notewise/wiki/Configuration

A sample configuration file demonstrating key-value pairs and comments.

```dotenv
DEFAULT_MODEL=gemini/gemini-2.5-flash
OUTPUT_DIR=./output
MAX_CONCURRENT_VIDEOS=5
YOUTUBE_REQUESTS_PER_MINUTE=10
TEMPERATURE=0.7
# MAX_TOKENS=2500
GEMINI_API_KEY=your_key_here
```

--------------------------------

### Clone yt-study repository and initialize submodules

Source: https://github.com/whoisjayd/notewise/wiki/Installation

To install from source, first clone the GitHub repository. Then, navigate into the directory and initialize any necessary git submodules.

```bash
git clone https://github.com/whoisjayd/yt-study.git
cd yt-study
git submodule update --init --recursive
```

--------------------------------

### Verify Development Setup

Source: https://github.com/whoisjayd/notewise/blob/main/CONTRIBUTING.md

Run the 'notewise version' command to verify that the development environment is set up correctly.

```bash
uv run notewise version
```

--------------------------------

### Verify yt-study installation

Source: https://github.com/whoisjayd/notewise/wiki/Installation

After installation, run this command to confirm that the yt-study CLI is accessible and to check its version.

```bash
yt-study version
```

--------------------------------

### Force re-run setup

Source: https://github.com/whoisjayd/notewise/wiki/FAQ

Use this command to re-initialize the application configuration.

```bash
yt-study setup --force
```

--------------------------------

### Setup Notewise CLI

Source: https://github.com/whoisjayd/notewise/wiki/Architecture

Command to set up Notewise, with an option to force re-setup.

```bash
yt-study setup [--force]
```

--------------------------------

### Install yt-study using pip

Source: https://github.com/whoisjayd/notewise/wiki/Installation

Use this command to install the yt-study package from the Python Package Index. Ensure you have Python 3.10 or newer installed.

```bash
pip install yt-study
```

--------------------------------

### Contributor install with hooks

Source: https://github.com/whoisjayd/notewise/wiki/Installation

This command installs the project in editable mode and sets up pre-commit hooks, which are recommended for contributors to ensure code quality.

```bash
make install-dev
```

--------------------------------

### Example Session Output

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/quickstart.mdx

An example of the output displayed when processing a YouTube video, showing the progress of metadata fetching, transcript generation, and note creation.

```bash
$ notewise process "https://youtube.com/watch?v=dQw4w9WgXcQ"

 notewise  v1.0.0

Processing 1 video...

 Video Title
   ✔ Metadata fetched
   ✔ Transcript fetched  (en, 342 segments)
   ✔ Notes generated  (3 chunks)
   ✔ Written → output/Video Title.md

────────────────────────────────────────
  1 processed · 0 failed · 12.4s · $0.0004
```

--------------------------------

### Run yt-study process examples

Source: https://github.com/whoisjayd/notewise/wiki/Usage

Various ways to invoke the process command for different media types and configurations.

```bash
yt-study process "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
```

```bash
yt-study process "https://www.youtube.com/playlist?list=PLAYLIST_ID"
```

```bash
yt-study process urls.txt
```

```bash
yt-study process "URL" -m gemini/gemini-2.5-flash -o ./course-notes
```

```bash
yt-study process "URL" -l hi -l en
```

```bash
yt-study process "URL" -t 0.4 -k 2500
```

```bash
yt-study process "URL" --force --quiz
```

```bash
yt-study process "URL" --no-ui
```

--------------------------------

### Install yt-study as a reusable tool with uv

Source: https://github.com/whoisjayd/notewise/wiki/Installation

Install yt-study as a globally available tool using `uv`. This method ensures the tool is managed by `uv` for easy updates and uninstalls.

```bash
uv tool install yt-study
```

--------------------------------

### Optional editable install from source

Source: https://github.com/whoisjayd/notewise/wiki/Installation

For development purposes, you can perform an editable install. This allows changes in your local source code to be reflected immediately without reinstallation.

```bash
make install
```

--------------------------------

### Check for Updates and Version

Source: https://context7.com/whoisjayd/notewise/llms.txt

Check for a newer release and print upgrade commands for your installation method using the `update` command. The `version` command shows the installed version.

```bash
# Check for updates
notewise update
```

```bash
# Show installed version
notewise version
```

--------------------------------

### Install Notewise with uv

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/installation.mdx

Use uv to install Notewise as an isolated global tool. This method makes the command available anywhere on your PATH and manages Python versions automatically.

```bash
uv tool install notewise
```

--------------------------------

### Verify Notewise Configuration

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/overview.mdx

Check the current configuration settings and the path to the active config file after setup.

```bash
notewise config
```

```bash
notewise config-path
```

--------------------------------

### Editable install with uv

Source: https://github.com/whoisjayd/notewise/wiki/Installation

An alternative method to perform an editable install using `uv`. This is useful if you are managing your project dependencies with `uv`.

```bash
uv pip install -e .
```

--------------------------------

### Commit Message Examples

Source: https://github.com/whoisjayd/notewise/blob/main/CONTRIBUTING.md

Examples of valid commit messages using the conventional format.

```text
feat(cli): add --export-transcript option to process command
fix(pipeline): handle transcript fetch retry on IPBlockError
docs: update README quick start section
test(storage): add coverage for cache prune edge cases
refactor(llm): extract UsageTotals into provider module
chore: bump litellm to 1.81.1
```

--------------------------------

### Install Shell Completion

Source: https://context7.com/whoisjayd/notewise/llms.txt

Enable command-line auto-completion for supported shells.

```bash
# Bash
notewise --install-completion bash

# Zsh
notewise --install-completion zsh

# Fish
notewise --install-completion fish
```

--------------------------------

### Install Shell Completion for Fish

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/overview.mdx

Install shell completion for the fish shell to enable command autocompletion.

```bash
notewise --install-completion fish
```

--------------------------------

### Install Notewise with pip

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/installation.mdx

Install Notewise using pip. Note that this places the executable in the current Python environment's scripts directory.

```bash
pip install notewise
```

--------------------------------

### Install Shell Completion for Zsh

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/overview.mdx

Install shell completion for the zsh shell to enable command autocompletion.

```bash
notewise --install-completion zsh
```

--------------------------------

### Install Shell Completion for Bash

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/overview.mdx

Install shell completion for the bash shell to enable command autocompletion.

```bash
notewise --install-completion bash
```

--------------------------------

### Process Playlist

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/process.mdx

Examples of processing entire YouTube playlists.

```bash
notewise process "https://youtube.com/playlist?list=PLxxxxxx"
notewise process PLxxxxxx          # bare playlist ID
```

--------------------------------

### Standard Output Structure

Source: https://github.com/whoisjayd/notewise/blob/main/README.md

Example of the file structure generated in the output directory.

```text
output/
├── Learn Python in Less than 10 Minutes for Beginners (Fast & Easy).md
├── Learn Python in Less than 10 Minutes for Beginners (Fast & Easy)_quiz.md
└── Learn Python in Less than 10 Minutes for Beginners (Fast & Easy)_transcript.json
```

--------------------------------

### Upgrade Notewise with uv

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/installation.mdx

Upgrade an existing Notewise installation managed by uv.

```bash
uv tool upgrade notewise
```

--------------------------------

### Add dependencies

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/local-setup/setup.mdx

Installs new packages and updates the lock file.

```bash
uv add some-package          # runtime dependency
uv add --dev some-package    # dev-only dependency
```

--------------------------------

### View output directory structures

Source: https://github.com/whoisjayd/notewise/wiki/Usage

Examples of how generated files are organized based on the processing mode.

```text
output/
  Video Title.md
```

```text
output/
  Video Title/
    01_Intro.md
    02_Setup.md
    03_Implementation.md
```

```text
output/
  Playlist Name/
    Video One.md
    Long Video/
      01_Intro.md
```

--------------------------------

### NoteWise Docker with environment variables

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/guides/docker.mdx

Configure NoteWise by passing environment variables to the Docker container. This example sets the API key, default model, max concurrent videos, and temperature.

```bash
docker run --rm \
  -e GEMINI_API_KEY="your_key" \
  -e DEFAULT_MODEL="gemini/gemini-2.5-flash" \
  -e MAX_CONCURRENT_VIDEOS="3" \
  -e TEMPERATURE="0.5" \
  -v "$(pwd)/output:/output" \
  ghcr.io/whoisjayd/notewise:latest \
  process "URL" --no-ui
```

--------------------------------

### Run yt-study without permanent installation using uvx

Source: https://github.com/whoisjayd/notewise/wiki/Installation

Execute yt-study commands directly without installing it globally by using `uvx`. This is useful for testing or temporary usage.

```bash
uvx yt-study --help
```

--------------------------------

### Integration Test Repository Lifecycle

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/local-setup/testing.mdx

Example of an integration test demonstrating the lifecycle of a repository using a temporary directory for the database.

```python
def test_repository_lifecycle(tmp_path):
    db_path = tmp_path / ".notewise_cache.db"
    repo = DatabaseRepository(db_path)
    ...

```

--------------------------------

### Troubleshooting Notewise

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/quickstart.mdx

If Notewise encounters an issue, start troubleshooting with `notewise doctor`. You can then check configuration with `notewise config` and view logs with `notewise logs --tail 80`. Refer to the full troubleshooting guide for more details.

```bash
notewise doctor
notewise config
notewise logs --tail 80
```

--------------------------------

### Install pre-commit hooks

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/local-setup/setup.mdx

Configures git hooks to enforce formatting and commit message standards.

```bash
uv run pre-commit install
```

--------------------------------

### Process Batch File

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/process.mdx

Examples of processing multiple URLs defined in a text file.

```bash
notewise process my-urls.txt
notewise process ~/course/urls.txt -o ~/course/notes
```

--------------------------------

### Docker Usage for Video Processing

Source: https://context7.com/whoisjayd/notewise/llms.txt

Run Notewise in a Docker container for reproducible, stateless processing. Examples show basic usage with Gemini and OpenAI, including volume mounting for output and setting API keys via environment variables.

```bash
# Basic usage with Gemini
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
```

```bash
# Use OpenAI instead
docker run --rm \
  -e OPENAI_API_KEY="sk-..." \
  -v "$(pwd)/output:/output" \
  ghcr.io/whoisjayd/notewise:latest \
  process "URL" --model gpt-4o --no-ui
```

--------------------------------

### Build NoteWise Docker image locally

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/guides/docker.mdx

Clone the repository, navigate to the directory, build the Docker image with a local tag, and then run it.

```bash
git clone https://github.com/whoisjayd/notewise
cd notewise
docker build -t notewise:local .
docker run --rm \
  -e GEMINI_API_KEY="your_key" \
  -v "$(pwd)/output:/output" \
  notewise:local process "URL" --no-ui
```

--------------------------------

### View Output File Structure

Source: https://context7.com/whoisjayd/notewise/llms.txt

Understand the directory layout and file naming conventions generated by NoteWise.

```bash
# Standard video output
./output/
  Video Title.md                    # Study notes
  Video Title_quiz.md               # Quiz (if --quiz)
  Video Title_transcript.txt        # Transcript (if --export-transcript txt)
  Video Title_transcript.json       # Transcript (if --export-transcript json)

# Long video with chapters (> 1 hour with chapter markers)
./output/
  Long Course Title/
    01_Introduction.md              # Per-chapter notes
    02_Core Concepts.md
    03_Advanced Topics.md
    Long Course Title_quiz.md       # Combined quiz (if --quiz)
    Long Course Title_transcript.txt # Full transcript (if --export-transcript)
```

--------------------------------

### Process Video with Model

Source: https://github.com/whoisjayd/notewise/blob/main/README.md

Use the process command to generate notes from a URL, optionally specifying a model.

```bash
notewise process "URL" --model claude-3-5-sonnet-20241022
```

--------------------------------

### Print Notewise Configuration File Path

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Prints the path to the Notewise configuration file and indicates whether it exists.

```bash
notewise config-path
```

--------------------------------

### Open Notewise Configuration File for Editing

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Opens the primary configuration file (`config.env`) in the default editor. Uses Notepad on Windows if `$EDITOR` is not set.

```bash
notewise edit-config
```

--------------------------------

### Upgrade Notewise with pip

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/installation.mdx

Upgrade an existing Notewise installation managed by pip.

```bash
pip install --upgrade notewise
```

--------------------------------

### Key Files and Environment Variable

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Information about important Notewise files and how to override the default state directory.

```APIDOC
## Key Files

| File |
| --- |
| `~/.notewise/config.env` | Primary config file |
| `~/.notewise/.notewise_cache.db` | SQLite cache |
| `~/.notewise/logs/` | Session log files |

### Override State Directory
Override the state directory using the `NOTEWISE_HOME` environment variable.

```bash
export NOTEWISE_HOME=/custom/path
```
```

--------------------------------

### Upgrade Notewise with pipx

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/installation.mdx

Upgrade an existing Notewise installation managed by pipx.

```bash
pipx upgrade notewise
```

--------------------------------

### Run Notewise with Docker

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/installation.mdx

Quickly run Notewise using a Docker container, processing a YouTube video and saving output to a local directory. Requires an API key and mounts a volume for output.

```bash
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
```

--------------------------------

### Define configuration file path

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/configuration.mdx

The default location for the Notewise configuration file.

```text
~/.notewise/config.env
```

--------------------------------

### Display configuration path

Source: https://github.com/whoisjayd/notewise/wiki/FAQ

Use this command to locate the current configuration file path.

```bash
yt-study config-path
```

--------------------------------

### CLI Reference Syntax

Source: https://github.com/whoisjayd/notewise/blob/main/README.md

General syntax for executing Notewise commands.

```text
notewise [COMMAND] [OPTIONS]
```

--------------------------------

### Process Single Video

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/process.mdx

Examples of processing individual videos using URLs or IDs.

```bash
notewise process "https://youtube.com/watch?v=dQw4w9WgXcQ"
notewise process "https://youtu.be/dQw4w9WgXcQ"
notewise process "https://youtube.com/shorts/dQw4w9WgXcQ"
notewise process dQw4w9WgXcQ      # bare 11-character video ID
```

--------------------------------

### Configure output directory

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/configuration.mdx

Set the directory where study notes will be saved.

```bash
OUTPUT_DIR=~/study-notes    # default: ./output
```

--------------------------------

### Clone the repository

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/local-setup/setup.mdx

Initializes the local project directory from the remote repository.

```bash
git clone https://github.com/whoisjayd/notewise
cd notewise
```

--------------------------------

### Apply Environment Overrides

Source: https://github.com/whoisjayd/notewise/wiki/Configuration

Example of overriding a configuration value using an environment variable during execution.

```bash
DEFAULT_MODEL=openai/gpt-4o yt-study process "URL"
```

--------------------------------

### Implement conditional logic with variables

Source: https://github.com/whoisjayd/notewise/blob/main/demo/Learn Python in Less than 10 Minutes for Beginners (Fast & Easy).md

Examples of using if-elif-else blocks with integer comparisons and boolean flags.

```python
age = 28

if age > 21:
    print("You are old")
elif age == 18:
    print("You are getting old")
else:
    print("You are still young")
# Output: You are old (because 28 > 21 is True)
```

```python
is_happy = False

if is_happy: # This is equivalent to 'if is_happy == True:'
    print("You are happy")
else:
    print("You are not happy")
# Output: You are not happy (because 'is_happy' is False)

is_happy = True
if is_happy:
    print("You are happy")
else:
    print("You are not happy")
# Output: You are happy (because 'is_happy' is True)
```

--------------------------------

### Configure NoteWise Environment

Source: https://context7.com/whoisjayd/notewise/llms.txt

Define default settings and API keys in the configuration file located at ~/.notewise/config.env.

```bash
# ~/.notewise/config.env

# LLM Model (LiteLLM format)
DEFAULT_MODEL=gemini/gemini-2.5-flash

# Output directory for generated notes
OUTPUT_DIR=./output

# LLM sampling temperature (0.0-1.0)
TEMPERATURE=0.7

# Max tokens per LLM response (unset = model default)
# MAX_TOKENS=2000

# Max concurrent video processing
MAX_CONCURRENT_VIDEOS=5

# YouTube request rate limit
YOUTUBE_REQUESTS_PER_MINUTE=10

# Cookie file for private videos
# YOUTUBE_COOKIE_FILE=/path/to/cookies.txt

# API Keys (set only the one(s) you use)
GEMINI_API_KEY=your_gemini_key
# OPENAI_API_KEY=sk-...
# ANTHROPIC_API_KEY=sk-ant-...
# GROQ_API_KEY=gsk_...
# XAI_API_KEY=xai-...
# MISTRAL_API_KEY=...
# COHERE_API_KEY=...
# DEEPSEEK_API_KEY=...

# Override config directory
# export NOTEWISE_HOME=/custom/path
```

--------------------------------

### Process Command Synopsis

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/process.mdx

The basic syntax for initiating the processing of a YouTube URL.

```bash
notewise process URL [OPTIONS]
```

--------------------------------

### Async Unit Tests

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/local-setup/testing.mdx

Example of an asynchronous unit test. No special decorator is needed due to 'asyncio_mode = "auto"'.

```python
async def test_pipeline_run(mocker):
    mocker.patch("notewise.pipeline._execution.fetch_transcript", ...)
    result = await pipeline.run(["VIDEO_ID"])
    assert result.success_count == 1

```

--------------------------------

### notewise config-path

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Print the path to the configuration file and indicate whether it exists.

```APIDOC
## `notewise config-path`

### Description
Print the config file path and whether it exists.

### Usage
```bash
notewise config-path
```
```

--------------------------------

### Check for Updates

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/operations.mdx

Run `notewise update` to check for the latest release and get upgrade commands. This command does not replace the running binary in place.

```bash
notewise update
```

--------------------------------

### Run Notewise with Docker

Source: https://github.com/whoisjayd/notewise/blob/main/README.md

Executes the Notewise container to process a YouTube video. Ensure the output directory is mounted to access generated files.

```bash
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" --no-ui
```

--------------------------------

### Build package

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/local-setup/setup.mdx

Generates distribution files for the project.

```bash
make build
# Produces:
# dist/notewise-X.Y.Z-py3-none-any.whl
# dist/notewise-X.Y.Z.tar.gz
```

--------------------------------

### Configure LLM and API keys

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/configuration.mdx

Set the default model and corresponding API key for the chosen provider.

```bash
# Default — free tier via Google AI Studio
DEFAULT_MODEL=gemini/gemini-2.5-flash
GEMINI_API_KEY=your_key_here
```

```bash
DEFAULT_MODEL=gpt-4o
OPENAI_API_KEY=sk-...
```

--------------------------------

### Mocking External Calls in Unit Tests

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/local-setup/testing.mdx

Example of using the 'mocker' fixture to patch external functions and assert their calls within a unit test.

```python
def test_fetch_transcript(mocker):
    mock_fetch = mocker.patch(
        "notewise.youtube.transcript.fetch_transcript",
        return_value=mock_transcript,
    )
    ...
    mock_fetch.assert_called_once_with("VIDEO_ID", languages=["en"])

```

--------------------------------

### View and Manage Configuration

Source: https://context7.com/whoisjayd/notewise/llms.txt

Commands to display, locate, and edit your NoteWise configuration. This includes viewing the resolved runtime configuration, the path to the config file, and opening the config file in your default editor.

```bash
# Show fully resolved runtime configuration (API keys masked)
notewise config
```

```bash
# Print path to active config file
notewise config-path
```

```bash
# Open config file in your $EDITOR
notewise edit-config
```

```bash
# Example ~/.notewise/config.env:
# DEFAULT_MODEL=gemini/gemini-2.5-flash
# OUTPUT_DIR=~/study-notes
# MAX_CONCURRENT_VIDEOS=3
# TEMPERATURE=0.7
# GEMINI_API_KEY=your_key_here
```

--------------------------------

### Assign String Values in Python

Source: https://github.com/whoisjayd/notewise/blob/main/demo/Learn Python in Less than 10 Minutes for Beginners (Fast & Easy).md

Strings represent textual data and must be enclosed in quotation marks. This example shows assigning text and a numeric string.

```python
text_value = "This is some text" # 'text_value' is a string
string_number = "22" # Even though it looks like a number, the quotes make it a string
```

--------------------------------

### Declare and Assign String Variables in Python

Source: https://github.com/whoisjayd/notewise/blob/main/demo/Learn Python in Less than 10 Minutes for Beginners (Fast & Easy).md

Strings are text data enclosed in single or double quotes. This example shows assigning different string literals to variables.

```python
item = "banana" # "banana" is a string
item_name = "orange" # "orange" is another string
```

--------------------------------

### Inspect Runtime Environment or Metadata

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/operations.mdx

Use `notewise info` to print runtime environment details without a URL. With a URL, it inspects metadata without generating notes.

```bash
notewise info
```

```bash
notewise info "https://youtube.com/watch?v=VIDEO_ID"
```

```bash
notewise info "https://youtube.com/playlist?list=PLAYLIST_ID"
```

--------------------------------

### E2E Test Public Video Transcript Fetch

Source: https://github.com/whoisjayd/notewise/blob/main/docs/development/local-setup/testing.mdx

Example of an end-to-end test for fetching a transcript of a public YouTube video. Designed to pass without an API key.

```python
# tests/e2e/test_public_smoke.py
def test_public_video_transcript_fetch():
    ...  # uses a known-stable public video

```

--------------------------------

### Configure OUTPUT_DIR

Source: https://github.com/whoisjayd/notewise/blob/main/docs/reference/schema-and-output/configuration.mdx

Set the directory where study notes are written.

```bash
OUTPUT_DIR=~/study-notes
OUTPUT_DIR=/data/notewise-output
```

--------------------------------

### Python for loop with range(3)

Source: https://github.com/whoisjayd/notewise/blob/main/demo/Learn Python in Less than 10 Minutes for Beginners (Fast & Easy).md

Use range(n) to create a loop that iterates n times, starting from 0. The loop variable takes on values from 0 up to n-1.

```python
for i in range(3):
    print("Hello", i)
# Output:
# Hello 0
# Hello 1
# Hello 2
```

--------------------------------

### Process a Video URL

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/overview.mdx

Initiate the first run by processing a YouTube video URL. This command generates study notes from the provided video.

```bash
notewise process "https://youtube.com/watch?v=VIDEO_ID"
```

--------------------------------

### Python for loop with adjusted range output

Source: https://github.com/whoisjayd/notewise/blob/main/demo/Learn Python in Less than 10 Minutes for Beginners (Fast & Easy).md

To modify the output of a range-based loop to start from a different number (e.g., 1), add an offset to the loop variable during operations like printing.

```python
for i in range(3):
    print("Hello", i + 1)
# Output:
# Hello 1
# Hello 2
# Hello 3
```

--------------------------------

### Fix Missing or Wrong API Key

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/guides/troubleshooting.mdx

If authentication errors occur or `doctor` reports a missing key, reconfigure and force setup. Ensure the correct API key is set for the model prefix.

```bash
notewise config
notewise setup --force
```

--------------------------------

### Check for Latest Release

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/operations.mdx

Use `notewise version` to check for the latest release and display upgrade commands. It does not replace the running binary.

```bash
notewise version
```

--------------------------------

### Check available languages for a URL

Source: https://github.com/whoisjayd/notewise/blob/main/docs/skill.md

Use this command to list supported languages for a specific video URL.

```bash
notewise info "URL"
```

--------------------------------

### Notewise CLI Basic Usage

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/commands/overview.mdx

Run `notewise` without any command to print a summary of available commands. Use `notewise COMMAND --help` for detailed help on a specific command.

```bash
notewise [COMMAND] [OPTIONS] [ARGS]
```

--------------------------------

### Batch Processing from Text File

Source: https://context7.com/whoisjayd/notewise/llms.txt

Process multiple YouTube URLs listed in a text file. Each line can be a video URL, playlist URL, or bare ID. Blank lines and lines starting with '#' are ignored. You can specify a custom output directory and control concurrency.

```bash
# Create a batch file (my-course.txt):
# https://youtube.com/watch?v=VIDEO_ID_1
# https://youtube.com/watch?v=VIDEO_ID_2
# # This is a comment
# https://youtube.com/playlist?list=PLxxxxxx

# Process all URLs in the batch file
notewise process my-course.txt
```

```bash
notewise process ~/course/urls.txt -o ~/course/notes
```

```bash
MAX_CONCURRENT_VIDEOS=10 notewise process urls.txt --no-ui
```

--------------------------------

### Process Videos using Docker

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/index.mdx

Run NoteWise within a Docker container for CI or isolated environments. Mount a local directory for output and provide necessary API keys as environment variables.

```bash
docker run --rm \
  -e GEMINI_API_KEY="your_key" \
  -v "$(pwd)/output:/output" \
  ghcr.io/whoisjayd/notewise:latest \
  process "URL" --no-ui
```

--------------------------------

### Run NoteWise with Docker

Source: https://context7.com/whoisjayd/notewise/llms.txt

Execute NoteWise in a container with various configurations for batch processing, private video access, persistent state, and environment-based settings.

```bash
docker run --rm \
  -e GEMINI_API_KEY="your_key" \
  -v "$(pwd)/urls.txt:/urls.txt:ro" \
  -v "$(pwd)/output:/output" \
  ghcr.io/whoisjayd/notewise:latest \
  process /urls.txt --no-ui
```

```bash
docker run --rm \
  -e GEMINI_API_KEY="your_key" \
  -e YOUTUBE_COOKIE_FILE="/cookies/youtube.txt" \
  -v "$(pwd)/cookies:/cookies:ro" \
  -v "$(pwd)/output:/output" \
  ghcr.io/whoisjayd/notewise:latest \
  process "URL" --no-ui
```

```bash
docker run --rm \
  -e GEMINI_API_KEY="your_key" \
  -v "$(pwd)/notewise-state:/home/notewise/.notewise" \
  -v "$(pwd)/output:/output" \
  ghcr.io/whoisjayd/notewise:latest \
  process "URL" --no-ui
```

```bash
docker run --rm \
  -e GEMINI_API_KEY="your_key" \
  -e DEFAULT_MODEL="gemini/gemini-2.5-flash" \
  -e MAX_CONCURRENT_VIDEOS="3" \
  -e TEMPERATURE="0.5" \
  -v "$(pwd)/output:/output" \
  ghcr.io/whoisjayd/notewise:latest \
  process "URL" --no-ui
```

--------------------------------

### Run Notewise version with standalone binary on Windows

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/getting-started/installation.mdx

Check the version of Notewise using its executable on Windows.

```powershell
.\notewise.exe version
```

--------------------------------

### Edit and Verify Notewise Configuration

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Commands to edit the configuration file and then verify the changes.

```bash
notewise edit-config
```

```bash
notewise config
```

--------------------------------

### Run Notewise using Docker

Source: https://github.com/whoisjayd/notewise/blob/main/README.md

Execute Notewise within a Docker container. Mount a local directory for output and set the LLM API key as an environment variable.

```bash
docker pull ghcr.io/whoisjayd/notewise:latest

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"
```

--------------------------------

### View Logs

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/operations.mdx

Use `notewise logs` to list recent log files, tail the latest log with `--tail 80`, or open the log directory with `--open`.

```bash
notewise logs              # list recent log files
```

```bash
notewise logs --tail 80    # tail the latest log
```

```bash
notewise logs --open       # open log directory in file manager
```

--------------------------------

### Configure Default Model and API Key

Source: https://github.com/whoisjayd/notewise/blob/main/docs/docs/how-it-works/providers.mdx

Set the default LLM model and provide an API key by editing the configuration file.

```bash
DEFAULT_MODEL=gpt-4o
OPENAI_API_KEY=sk-...
```

--------------------------------

### notewise config

Source: https://github.com/whoisjayd/notewise/blob/main/docs/cli/config-and-operations/setup-and-config.mdx

Display the fully resolved runtime configuration. API keys are masked.

```APIDOC
## `notewise config`

### Description
Show the fully resolved runtime configuration. API keys are masked.

### Usage
```bash
notewise config
```
```

--------------------------------

### Process media with yt-study

Source: https://github.com/whoisjayd/notewise/wiki/Usage

The primary command for generating notes from a URL or file.

```bash
yt-study process [OPTIONS] URL_OR_FILE
```

--------------------------------

### Run Test Suite Commands

Source: https://github.com/whoisjayd/notewise/blob/main/CONTRIBUTING.md

Commands to execute various test layers or specific test files using make or uv.

```bash
# Full test suite (parallel)
make test

# Unit tests only with coverage
make test-unit

# Integration tests only
make test-integration

# Single test file
uv run pytest tests/unit/cli/test_display.py -v
```
Tokens:
Raw