second-brain

Installation

Clone the repository and install dependencies:

git clone <repo-url>
cd second-brain
uv sync

Usage

Via the CLI entrypoint:

uv run second_brain

With dev environment variables:

uv run --env-file .env second_brain

Via the Python module:

uv run python -m second_brain

Environment Variables

Copy .env.example to .env for development defaults:

cp .env.example .env

Variable	Default	Description
LOG_LEVEL	INFO	Console log level. Set to DEBUG in .env for verbose output.
LOG_FILE	app.log	Path to the log file.

Note: uv run --env-file .env loads the dev environment explicitly — variables are not auto-loaded.

Testing

Run tests:

uv run pytest

Run tests with coverage:

uv run pytest --cov

Documentation

Preview docs locally:

uv run python scripts/serve_docs.py

Build static docs:

uv run mkdocs build