Mindroad is a personal, local-first knowledge tracker for self-directed learners. Everything — subjects, roadmaps, notes, resources, progress — is stored in a single SQLite file on your own machine; there's no account and no cloud sync.
Install
uv tool install mindroad
Equivalent, if you don't have uv:
pipx install mindroad
Usage
mindroad
This starts the server at http://127.0.0.1:8420 and opens it in your browser.
Flags:
| Flag | Description |
|---|---|
--data-dir PATH |
Directory to store the Mindroad database in (overrides MINDROAD_DATA_DIR; default: platform data dir). |
--no-browser |
Don't automatically open a browser tab on startup. |
--dev |
Developer mode: normal uvicorn logging + auto-reload; skips the banner, first-run message, port self-identification, and auto-open. |
-V, --version |
Print the Mindroad version and exit. |
-h, --help |
Show the full help message. |
Running mindroad again while it's already running detects the existing instance and just opens it in your browser, rather than erroring.
Data location
By default, your data lives at the platform-appropriate data directory (via platformdirs), e.g. ~/.local/share/mindroad/mindroad.db on Linux. Override it with the MINDROAD_DATA_DIR environment variable, or --data-dir (which takes precedence over the environment variable).
Features
- Subjects — flat, standalone topics you're studying, each with a Markdown description, an optional emoji icon, and pin/archive state.
- Tags — many-to-many labels on subjects for filtering, colored from a fixed palette.
- Roadmaps — an ordered list of milestones per subject, optionally grouped into sections, rendered as a connected path.
- Milestones — individual learning objectives within a subject's roadmap, with derived status (not started / in progress / completed).
- Resources — up to 3 videos/books/articles/courses linked to each milestone.
- Notes — one Markdown note per milestone.
- Progress tracking — start/complete/reopen events per milestone, with live-computed rollup progress at the subject level, no cached state.
License
GPLv3 © 2026
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mindroad-0.1.0.tar.gz.
File metadata
- Download URL: mindroad-0.1.0.tar.gz
- Upload date:
- Size: 247.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"44","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1dd1f0932edc7e31eb41c95e257a736763d7f97d1868b7ae303a6a7bac53a1a5
|
|
| MD5 |
5c284f5f8418eff0f0f84619d337b0e7
|
|
| BLAKE2b-256 |
ff91b11d20684de2c5ae9625f4a341307cc891d9955d2d866f07dd0c5dbd44e3
|
File details
Details for the file mindroad-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mindroad-0.1.0-py3-none-any.whl
- Upload date:
- Size: 189.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"44","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a05adaa88f328d317a200e9104bb3f8ee32528956d73d6971115b196fa441d46
|
|
| MD5 |
ded8442293fc7facf89a5e2091e3a121
|
|
| BLAKE2b-256 |
547bbca02b50ed9252ed5949233eafd337836bac0ef184abe639e86ba3c317cf
|
