diff --git a/CLAUDE.md b/CLAUDE.md index 0db120f..3fce690 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -118,13 +118,6 @@ wiki log show [--last N] [--type T] # Print log entries wiki log append # Append log entry ``` -### Git Operations (git backend only) -``` -wiki commit [message] # Git add + commit (auto-message from last log entry) -wiki history [path] [--last N] # Git log -wiki diff [ref] # Git diff -``` - ### Health & Links ``` wiki lint [--json] # Check wiki health (broken links, orphans, frontmatter, index) @@ -134,20 +127,6 @@ wiki orphans # Pages with no inbound links wiki status [--json] # Wiki overview stats ``` -### GitHub Sync (git backend only) -``` -wiki auth login # Authenticate with GitHub PAT -wiki auth status # Show auth status -wiki auth logout # Remove credentials -wiki repo list [--all] [--filter] # List your GitHub repos -wiki repo create # Create repo + init wiki -wiki repo clone [name] [--dir] # Clone repo + register -wiki repo connect [wiki-id] # Connect wiki to new GitHub repo -wiki push # Git push -wiki pull # Git pull -wiki sync # Pull + push -``` - ## Architecture - **StorageProvider pattern**: All page I/O goes through the `StorageProvider` interface (5 methods: readPage, writePage, appendPage, pageExists, listPages). Three implementations: diff --git a/README.md b/README.md index ce88923..160034f 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,11 @@ The CLI is the hands -- it reads, writes, searches, and manages wiki files. The LLM Agent (Claude Code / Codex) | | shells out to: -| $ wiki init my-wiki --backend git --domain "machine learning" +| $ wiki init my-wiki --domain "machine learning" | $ wiki write wiki/concepts/attention.md <<'EOF' ... EOF | $ wiki index add "concepts/attention.md" "Overview of attention" | $ wiki search "scaling laws" | $ wiki lint -| $ wiki push | v wiki CLI (StorageProvider abstraction) @@ -130,13 +129,6 @@ wiki log show [--last N] [--type T] # Print log entries wiki log append # Append log entry ``` -### Git Operations (git backend only) -```bash -wiki commit [message] # Git add + commit -wiki history [path] [--last N] # Git log -wiki diff [ref] # Git diff -``` - ### Health & Links ```bash wiki lint [--json] # Health check @@ -146,20 +138,6 @@ wiki orphans # Pages with no inbound link wiki status [--json] # Wiki overview stats ``` -### GitHub Sync (git backend only) -```bash -wiki auth login # Authenticate with GitHub PAT -wiki auth status # Show auth status -wiki auth logout # Remove credentials -wiki repo list [--all] [--filter] # List your GitHub repos -wiki repo create [--domain] [--public] # Create repo + init wiki -wiki repo clone [name] [--dir] # Clone repo + register -wiki repo connect [wiki-id] # Connect wiki to new GitHub repo -wiki push # Git push -wiki pull # Git pull -wiki sync # Pull + push -``` - ## LLM Agent Skill Guide Run `wiki skill` to print the full guide, or see [`docs/SKILL.md`](docs/SKILL.md) for the source. Covers workflows, command patterns, page format, and common gotchas for LLM agents. @@ -207,14 +185,6 @@ wiki orphans # pages nobody links to wiki status # overview stats ``` -### Sync to GitHub -```bash -wiki auth login # one-time setup with GitHub PAT -wiki repo create research # creates private wiki-research repo -wiki push # after making changes -wiki sync # pull + push -``` - ## Multi-Wiki Support The CLI supports multiple wikis via a global registry at `~/.config/llmwiki/`: diff --git a/docs/SKILL.md b/docs/SKILL.md index f540698..5a490c8 100644 --- a/docs/SKILL.md +++ b/docs/SKILL.md @@ -124,8 +124,7 @@ wiki index add "sources/attention-paper.md" "Attention Is All You Need (2017)" wiki index add "concepts/transformers.md" "Transformer architecture overview" wiki log append ingest "Attention paper and transformer concepts" -# 5. Commit (git backend only — auto-committed on write for git backend) -wiki commit "ingest: attention paper" +# Done — git backend auto-commits on write ``` ### Answer a question using the wiki @@ -160,20 +159,6 @@ wiki status # overview stats wiki log append maintenance "Fixed broken links and orphan pages" ``` -### Sync to GitHub - -```bash -# One-time setup -wiki auth login # authenticate with GitHub PAT -wiki repo create my-wiki # creates private repo + connects - -# After making changes -wiki push - -# Or pull + push in one step -wiki sync -``` - ### Multi-wiki operations ```bash @@ -214,16 +199,6 @@ wiki search "neural networks" --all # search across all wikis | `wiki log show [--last N] [--type T]` | Print log entries (filter by count/type) | | `wiki log append ` | Append log entry (types: ingest, query, maintenance, etc.) | -### Git Operations (git backend only) - -| Command | Description | -|---------|-------------| -| `wiki commit [message]` | Git add + commit (auto-message from last log entry if omitted) | -| `wiki history [path] [--last N]` | Git log (optionally for a specific page) | -| `wiki diff [ref]` | Git diff (optionally against a ref) | - -> Note: With git backend, `wiki write` and `wiki append` auto-commit. Manual `wiki commit` is for custom commit messages or changes made outside the CLI. - ### Health & Links | Command | Description | @@ -234,30 +209,13 @@ wiki search "neural networks" --all # search across all wikis | `wiki orphans` | List pages with no inbound links | | `wiki status [--json]` | Wiki overview: page counts, link stats, recent activity, git info | -### GitHub Sync (git backend only) - -| Command | Description | -|---------|-------------| -| `wiki auth login` | Authenticate with GitHub PAT | -| `wiki auth status` | Show current auth status | -| `wiki auth logout` | Remove stored credentials | -| `wiki repo list [--all] [--filter F]` | List GitHub repos | -| `wiki repo create [--domain D] [--public]` | Create repo + init wiki | -| `wiki repo clone [name] [--dir D]` | Clone repo + register as wiki | -| `wiki repo connect [wiki-id]` | Connect existing wiki to new GitHub repo | -| `wiki push` | Git push to remote | -| `wiki pull` | Git pull from remote | -| `wiki sync` | Pull then push | - ## Gotchas 1. **Always use heredoc for write/append** — these commands read stdin, not arguments. Running `wiki write path.md "content"` will hang waiting for stdin. 2. **Always update index + log** — after creating or modifying pages, call `wiki index add` and `wiki log append`. The `wiki lint` command checks for pages missing from the index. -3. **Git commands require git backend** — `commit`, `push`, `pull`, `sync`, `history`, `diff` only work when `backend: git`. With git backend, writes auto-commit. - -4. **append fails if page doesn't exist** — use `wiki write` to create new pages, `wiki append` only for existing ones. +3. **append fails if page doesn't exist** — use `wiki write` to create new pages, `wiki append` only for existing ones. 5. **Wiki resolution** — if commands fail with "No wiki found", either `cd` into a wiki directory, run `wiki use ` to set a default, or pass `--wiki `.