-
Notifications
You must be signed in to change notification settings - Fork 0
CLI Commands
WikiNow provides 14 commands via wn (or wikinow). Built with Typer + Rich for panels, colors, and health bars.
Creates a new project with the full directory structure -- wiki folders, CLAUDE.md schema, Obsidian config, git repo.
$ wn init ml-research
██╗ ██╗██╗██╗ ██╗██╗███╗ ██╗ ██████╗ ██╗ ██╗
██║ ██║██║██║ ██╔╝██║████╗ ██║██╔═══██╗██║ ██║
██║ █╗ ██║██║█████╔╝ ██║██╔██╗ ██║██║ ██║██║ █╗ ██║
██║███╗██║██║██╔═██╗ ██║██║╚██╗██║██║ ██║██║███╗██║
╚███╔███╔╝██║██║ ██╗██║██║ ╚████║╚██████╔╝╚███╔███╔╝
╚══╝╚══╝ ╚═╝╚═╝ ╚═╝╚═╝╚═╝ ╚═══╝ ╚═════╝ ╚══╝╚══╝
Know it now. Keep it forever.
╭─ Project Created ───────────────────────────────────╮
│ Created ml-research │
│ ~/.wikinow/ml-research │
│ │
│ 1. Open project folder in Obsidian │
│ 2. Start server: wn serve │
│ 3. Connect: claude mcp add wikinow -- wn serve │
╰─────────────────────────────────────────────────────╯
Name rules: must start with a letter or number, then letters, numbers, hyphens, or underscores. No spaces, no special characters.
$ wn init "bad name"
╭─ Init Failed ───────────────────────────────────────╮
│ Invalid project name 'bad name'. Must start with... │
╰─────────────────────────────────────────────────────╯
Switches the active project. All subsequent commands operate on this project.
$ wn use ml-research
╭─ Switched ──────────────────────────────────────────╮
│ ● Active project: ml-research │
╰─────────────────────────────────────────────────────╯
Shows all projects with the active one marked.
$ wn list
╭─ Projects ──────────────────────────────────────────╮
│ ● ml-research (active) │
│ ○ trip-planning │
│ ○ book-notes │
╰─────────────────────────────────────────────────────╯
Starts the MCP server over stdio. This is what AI tools connect to.
# Connect from Claude Code
claude mcp add wikinow -- wn serve
# Connect from Codex
codex mcp add wikinow -- wn serveFor Cursor / VS Code, add to .vscode/mcp.json:
{
"mcpServers": {
"wikinow": {
"command": "wn",
"args": ["serve"]
}
}
}Smart ingestion -- auto-detects the source type.
URL:
$ wn ingest https://en.wikipedia.org/wiki/SQLite
╭─ Ingested ──────────────────────────────────────────╮
│ SQLite │
│ raw/sqlite.md · 12,450 chars │
│ Start MCP mode to compile into wiki │
╰─────────────────────────────────────────────────────╯
YouTube (auto-detected):
$ wn ingest https://www.youtube.com/watch?v=abc123
Extracts English subtitles via yt-dlp. If no subtitles, falls back to Whisper audio transcription (requires ffmpeg).
Local file:
$ wn ingest paper.pdf
$ wn ingest book.epub
$ wn ingest podcast.mp3
$ wn ingest notes.md
Duplicate detection:
$ wn ingest https://en.wikipedia.org/wiki/SQLite
╭─ Skipped ───────────────────────────────────────────╮
│ Duplicate content -- already ingested. │
╰─────────────────────────────────────────────────────╯
Full-text search with porter stemming -- "transformers" matches "transformer".
$ wn search "attention mechanism"
╭─ Search: attention mechanism ───────────────────────╮
│ Transformer Architecture high │
│ concepts/transformer.md │
│ Self-attention mechanism for sequence modeling... │
│ │
│ Attention Is All You Need high │
│ sources/vaswani-2017.md │
│ Foundational paper introducing the transformer... │
╰─────────────────────────────────────────────────────╯
Reads a wiki article rendered as markdown in the terminal.
$ wn read concepts/transformer.md
──────────────── concepts/transformer.md ─────────────
# Transformer Architecture
...
Path traversal protected -- wn read ../../../etc/passwd is blocked.
Project statistics at a glance.
$ wn stats
╭─ ml-research ───────────────────────────────────────╮
│ 📄 Articles 12 │
│ 📥 Raw sources 8 │
│ ✅ Compiled 6 │
│ ⏳ Pending 2 │
│ 🔗 Links 47 │
│ 🏷️ Tags 15 │
│ ⚡ Contradictions 1 │
╰─────────────────────────────────────────────────────╯
Health check with a visual health bar (10 blocks).
$ wn lint
╭─ Health Check ──────────────────────────────────────╮
│ █████████░ 90% │
│ │
│ ⚠ Orphan pages (1) │
│ ○ concepts/tokenization.md │
│ │
│ ⚠ Uncompiled (1) │
│ ○ new-paper.pdf │
╰─────────────────────────────────────────────────────╯
Health score: starts at 100%, loses 5% per issue. Color changes: green (80%+), yellow (50-79%), red (below 50%).
Shows knowledge gaps and open questions from wiki/gaps.md.
Shows current config as syntax-highlighted YAML.
Updates a config value using dot notation. Supports type coercion -- "true" becomes boolean, "20" becomes integer.
$ wn config whisper.model large-v3
╭─ Config Updated ────────────────────────────────────╮
│ whisper.model = large-v3 │
╰─────────────────────────────────────────────────────╯
$ wn config search.max_results 20
$ wn config ingestion.auto_compile false
Concatenates overview, index, and all article pages into a single markdown file.
$ wn export
╭─ Exported ──────────────────────────────────────────╮
│ ml-research-export.md │
│ ~/.wikinow/ml-research/ml-research-export.md · 45KB │
╰─────────────────────────────────────────────────────╯
Shows the ASCII logo and version number.
Every command that requires an active project shows a clear error if none exists:
$ wn stats
╭─ No Active Project ─────────────────────────────────╮
│ Run wn init <name> to create a project first. │
╰─────────────────────────────────────────────────────╯