llmwiki-cli
Advanced tools
+4
-1
| { | ||
| "name": "llmwiki-cli", | ||
| "version": "0.1.5", | ||
| "version": "0.2.1", | ||
| "description": "CLI tool for LLM agents to build and maintain personal knowledge bases", | ||
@@ -29,2 +29,5 @@ "repository": { | ||
| }, | ||
| "optionalDependencies": { | ||
| "@supabase/supabase-js": "^2.49.0" | ||
| }, | ||
| "devDependencies": { | ||
@@ -31,0 +34,0 @@ "@types/bun": "latest", |
+27
-41
@@ -27,13 +27,11 @@ # llmwiki-cli | ||
| | $ wiki lint | ||
| | $ wiki commit "ingest: attention paper" | ||
| | $ wiki push | ||
| | | ||
| v | ||
| wiki CLI (pure filesystem + git) | ||
| wiki CLI (StorageProvider abstraction) | ||
| | | ||
| v | ||
| Wiki Repo (markdown files + .git + GitHub) | ||
| filesystem | git (auto-commit + auto-push) | supabase (database) | ||
| ``` | ||
| **Key principle**: The CLI never calls any LLM API. It is a pure filesystem + git tool. | ||
| **Key principle**: The CLI never calls any LLM API. It is a pure storage tool with pluggable backends. | ||
@@ -48,8 +46,19 @@ ## Install | ||
| ## Storage Backends | ||
| | Backend | Description | Init | | ||
| |---------|-------------|------| | ||
| | `filesystem` (default) | Plain markdown files on disk | `wiki init my-wiki` | | ||
| | `git` | Filesystem + auto-commit + auto-push to GitHub | `wiki init my-wiki --backend git --git-token <pat>` | | ||
| | `supabase` | Pages in a Supabase database table | `wiki init my-wiki --backend supabase --supabase-url <url> --supabase-key <key>` | | ||
| ## Quick Start | ||
| ```bash | ||
| # Create a new wiki | ||
| # Create a new wiki (filesystem backend, default) | ||
| wiki init my-wiki --name "My Notes" --domain "research" | ||
| # Or with git + GitHub sync | ||
| wiki init my-wiki --name "My Notes" --domain "research" --backend git --git-token ghp_xxx | ||
| # Write a page | ||
@@ -70,6 +79,5 @@ wiki write wiki/concepts/attention.md <<'EOF' | ||
| # Search, lint, commit | ||
| # Search and lint | ||
| wiki search "attention" | ||
| wiki lint | ||
| wiki commit "ingest: attention mechanism" | ||
| ``` | ||
@@ -79,8 +87,8 @@ | ||
| When you run `wiki init`, it creates: | ||
| When you run `wiki init` (filesystem or git backend), it creates: | ||
| ``` | ||
| my-wiki/ | ||
| ├── .git/ | ||
| ├── .llmwiki.yaml # Wiki config | ||
| ├── .git/ # Only with --backend git | ||
| ├── .llmwiki.yaml # Wiki config (all backends) | ||
| ├── SCHEMA.md # Instructions for LLM agents | ||
@@ -98,2 +106,4 @@ ├── raw/ # Immutable source documents | ||
| For supabase backend, only `.llmwiki.yaml` is created locally. Pages are stored in the `wiki_pages` database table. | ||
| ## Commands | ||
@@ -103,3 +113,5 @@ | ||
| ```bash | ||
| wiki init [dir] --name <name> --domain <domain> # Create new wiki | ||
| wiki init [dir] --name <name> --domain <domain> --backend <type> | ||
| wiki init [dir] --backend git --git-token <pat> [--git-repo owner/repo] | ||
| wiki init [dir] --backend supabase --supabase-url <url> --supabase-key <key> | ||
| wiki registry # List all wikis | ||
@@ -125,5 +137,2 @@ wiki use [wiki-id] # Set active wiki | ||
| wiki log append <type> <message> # Append log entry | ||
| wiki commit [message] # Git add + commit | ||
| wiki history [path] [--last N] # Git log | ||
| wiki diff [ref] # Git diff | ||
| ``` | ||
@@ -140,16 +149,2 @@ | ||
| ### GitHub Sync | ||
| ```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 <name> [--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 | ||
@@ -185,3 +180,2 @@ | ||
| wiki log append ingest "Attention paper" | ||
| wiki commit "ingest: attention paper" | ||
| ``` | ||
@@ -202,13 +196,4 @@ | ||
| wiki status # overview stats | ||
| wiki commit "maintenance: fix lint issues" | ||
| ``` | ||
| ### 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 | ||
@@ -232,3 +217,4 @@ | ||
| - Node.js >= 18 (or Bun) | ||
| - Git (optional but recommended for version control) | ||
| - Git (for `--backend git` only) | ||
| - `@supabase/supabase-js` (for `--backend supabase` only — optional dependency) | ||
@@ -241,3 +227,3 @@ ## Development | ||
| bun install | ||
| bun test # 192 tests | ||
| bun test # 210 tests | ||
| bun run build # bundle to dist/wiki.js | ||
@@ -244,0 +230,0 @@ bun run dev -- --help |
Sorry, the diff of this file is too big to display
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Found 1 instance in 1 package
648047
171.27%16739
155.13%8
-33.33%3
50%228
-5.79%202
6633.33%