Lightweight project-agnostic CLI for templated notes and log indexes
Project description
notio
notio is a lightweight, project-agnostic CLI for creating templated Markdown notes and maintaining browsable log indexes.
It is meant for repositories that want plain Markdown notes with predictable structure, local templates, and repo-owned index pages, without introducing a database or a large documentation framework.
Install
pip install notio
Package surface
notio initnotio note <type>notio toc [<type>|--all]notio diataxis initnotio diataxis add <section> <slug>notio diataxis toc [<section>|--all]notio mcp— Start FastMCP server (stdio) for agent integration
The source of truth is the Python CLI plus notio.toml. Make wrappers are optional convenience only.
MCP server
Notio includes an optional MCP server (pip install notio[mcp]) that exposes note operations as tools for AI agents:
| Tool | Description |
|---|---|
note_list |
List recent notes by type |
note_latest |
Most recent note content |
note_read |
Read a specific note by path |
note_create |
Create a new note |
note_update |
Update note frontmatter fields |
note_types |
List configured note types |
note_search |
Semantic search over notes |
Start standalone: notio mcp
Or via projio: projio mcp -C . (aggregates all ecosystem tools).
Quickstart
Initialize a workspace:
notio init --write-config
Create a note:
notio note meeting --title "Sprint sync"
Rebuild all indexes:
notio toc --all
Scaffold Diataxis documentation:
notio diataxis init --mkdocs
notio diataxis add tutorial quickstart --title "Getting Started"
Local development
Install with development dependencies:
pip install -e ".[dev]"
Run tests:
make test
Run directly from the repository without installation:
PYTHONPATH=src python -m notio --root . init
PYTHONPATH=src python -m notio --root . note meeting --title "Sprint sync"
PYTHONPATH=src python -m notio --root . toc --all
Documentation
The repository includes an MkDocs site with a Diataxis-style structure:
- Tutorials
- How-to guides
- Explanation
- Reference
Build docs locally with:
pip install ".[docs]"
mkdocs serve
Configuration
notio reads configuration from:
notio.toml[tool.notio]inpyproject.toml
Make wrappers
make initmake note-dailymake note-weeklymake note-issue TITLE="Fix plotting bug"make toc-all
Release
See RELEASE.md for build and publish instructions.
Project details
Release history Release notifications | RSS feed
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 notio-0.1.1.tar.gz.
File metadata
- Download URL: notio-0.1.1.tar.gz
- Upload date:
- Size: 42.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bdf64f5915a2a1d1d2aeda9edbc84d3d9c17b7a6c83ff1836cb2df1bdcb7ce40
|
|
| MD5 |
1c59a6ab4573da987ad7bff9ae3dc501
|
|
| BLAKE2b-256 |
713638f6e1019b0a1ce14a1010243c5451a3f63d19336a5a9e684248286ab229
|
File details
Details for the file notio-0.1.1-py3-none-any.whl.
File metadata
- Download URL: notio-0.1.1-py3-none-any.whl
- Upload date:
- Size: 43.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2b3323263618fa13eb8a43f2576ad69b5b5e96fe0198b02e2b3bced32a34f235
|
|
| MD5 |
1b5c19b9d16e02c57da8203a6a2ce12a
|
|
| BLAKE2b-256 |
a1fd6b2a3cc712816eb88118e90261ccd16a4f05f35769ed83b49958392dbedc
|