modv automates the creation, organization, and maintenance of engineering knowledge and projects. Instead of manually managing files, you express intent:
modv guide create "STM32 DMA Guide"
modv article create "Why Timing Jitter Destroys Control Performance"
modv research promote "DMA Investigation"
modv moc rebuild# Clone or unzip the project
cd modv
# Install (Python 3.10+ required)
pip install -e .
# First-time setup
modv initmodv init # First-time configuration wizard
modv status # Vault stats, note counts, integration statusmodv guide create "STM32 DMA Guide" # Create guide (prompts for domain)
modv guide create "Title" -d "RTOS" # Create in specific domain
modv guide list # List all guides
modv guide list --domain "RTOS" # Filter by domain
modv guide open "STM32 DMA Guide" # Open in editor
modv guide rename "Old" "New" # Rename + update backlinks
modv guide archive "Old Guide" # Move to 99 Archive/modv article create "Title" # Create article
modv article list # List all articles
modv article list --published # Published only
modv article publish "Title" # Mark as published
modv article publish "Title" --url "..." # With Substack URLmodv project create "pid-library" # Create project note
modv project create "Name" --git # + local git init
modv project create "Name" --github # + GitHub repo
modv project init "Name" # Init filesystem structure
modv project list # List all projects
modv project archive "Name" # Archivemodv research create "DMA Investigation"
modv research list
modv research promote "DMA Investigation" # → Permanent Note
modv research promote "Topic" --as "New Title" # Custom permanent titlemodv note create "Direct Memory Access"
modv note list
modv note link "DMA" "STM32_DMA_Guide" # Add wikilink
modv note merge "Draft Note" "Main Note" # Merge two notesmodv moc rebuild # Rebuild all MOC files
modv moc rebuild guide # Rebuild guides MOC only
modv moc verify # Health check: broken links, orphansmodv search "DMA" # Full-text search all notes
modv search "DMA" -t guide # Limit to guides
modv search "DMA" -n 5 # Limit results
modv weekly # Create this week's review noteConfig lives at ~/.config/modv/config.toml:
vault = "~/Documents/Knowledge/ModvWorks-Knowledge"
author = "Frank"
default_editor = "nvim"
[integrations]
linear = false
github = false
[linear]
api_key = "lin_api_..."
team_id = "TEAM-UUID"
project_id = ""
[github]
token = "ghp_..."
username = "your-username"
org = ""ModvWorks-Knowledge/
├── 10 Permanent Notes/
├── 30 Research/
├── 40 Technical Guides/
│ ├── Embedded Systems/
│ ├── RTOS/
│ ├── Control Systems/
│ └── Signal Processing/
├── 50 Weekly Reviews/
├── 60 Projects/
├── 70 Templates/
├── Engineering Writing/
└── 99 Archive/
pip install -e ".[dev]"
pytest tests/ModvWorks Foundry - Practical Systems Engineering for Real Products · modvworks.github.io