llmwiki-cli
Advanced tools
+21
| MIT License | ||
| Copyright (c) 2026 doum1004 | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
+2
-1
| { | ||
| "name": "llmwiki-cli", | ||
| "version": "0.1.3", | ||
| "version": "0.1.4", | ||
| "description": "CLI tool for LLM agents to build and maintain personal knowledge bases", | ||
@@ -9,2 +9,3 @@ "repository": { | ||
| }, | ||
| "license": "MIT", | ||
| "type": "module", | ||
@@ -11,0 +12,0 @@ "bin": { |
+71
-27
@@ -16,18 +16,21 @@ # llmwiki-cli | ||
| The CLI is the hands — it reads, writes, searches, and manages wiki files. The LLM is the brain — it decides what to create, update, and connect. | ||
| The CLI is the hands -- it reads, writes, searches, and manages wiki files. The LLM is the brain -- it decides what to create, update, and connect. | ||
| ``` | ||
| LLM Agent (Claude Code / Codex) | ||
| │ | ||
| │ shells out to: | ||
| │ $ 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 commit "ingest: attention paper" | ||
| │ | ||
| ▼ | ||
| | | ||
| | shells out to: | ||
| | $ 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 commit "ingest: attention paper" | ||
| | $ wiki push | ||
| | | ||
| v | ||
| wiki CLI (pure filesystem + git) | ||
| │ | ||
| ▼ | ||
| Wiki Repo (markdown files + .git) | ||
| | | ||
| v | ||
| Wiki Repo (markdown files + .git + GitHub) | ||
| ``` | ||
@@ -51,7 +54,21 @@ | ||
| # List your wikis | ||
| wiki registry | ||
| # Write a page | ||
| wiki write wiki/concepts/attention.md <<'EOF' | ||
| --- | ||
| title: Attention Mechanism | ||
| created: 2025-01-20 | ||
| tags: [transformers, NLP] | ||
| --- | ||
| The attention mechanism allows models to focus on relevant parts of the input. | ||
| See also [[transformers]] and [[self-attention]]. | ||
| EOF | ||
| # Set the active wiki | ||
| wiki use my-wiki | ||
| # Add to index and log | ||
| wiki index add "concepts/attention.md" "Overview of attention mechanisms" | ||
| wiki log append ingest "Attention mechanism page" | ||
| # Search, lint, commit | ||
| wiki search "attention" | ||
| wiki lint | ||
| wiki commit "ingest: attention mechanism" | ||
| ``` | ||
@@ -88,3 +105,3 @@ | ||
| ### Reading & Writing (Phase 2) | ||
| ### Reading & Writing | ||
| ```bash | ||
@@ -98,3 +115,3 @@ wiki read <path> # Print page to stdout | ||
| ### Index & Log (Phase 3) | ||
| ### Index & Log | ||
| ```bash | ||
@@ -111,3 +128,3 @@ wiki index show # Print master index | ||
| ### Health & Links (Phase 4) | ||
| ### Health & Links | ||
| ```bash | ||
@@ -121,7 +138,11 @@ wiki lint [--json] # Health check | ||
| ### GitHub Sync (Phase 5) | ||
| ### GitHub Sync | ||
| ```bash | ||
| wiki auth login # GitHub device flow auth | ||
| wiki repo create <name> [--public] # Create repo + wiki | ||
| wiki repo clone [name] # Clone repo + register | ||
| 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 | ||
@@ -134,6 +155,7 @@ wiki pull # Git pull | ||
| The generated `SCHEMA.md` in each wiki contains complete instructions. Here's the typical workflow: | ||
| The generated `SCHEMA.md` in each wiki contains complete instructions. Here are the typical workflows: | ||
| ### Ingest a Source | ||
| ```bash | ||
| # Save raw source | ||
| wiki write raw/paper.md <<'EOF' | ||
@@ -143,2 +165,3 @@ <paste full text of paper> | ||
| # Create structured summary | ||
| wiki write wiki/sources/attention-paper.md <<'EOF' | ||
@@ -152,4 +175,6 @@ --- | ||
| Summary of the attention paper... | ||
| Links to [[transformers]] and [[self-attention]]. | ||
| EOF | ||
| # Update bookkeeping | ||
| wiki index add "sources/attention-paper.md" "Attention Is All You Need (2017)" | ||
@@ -164,5 +189,22 @@ wiki log append ingest "Attention paper" | ||
| wiki read wiki/concepts/attention.md | ||
| wiki links wiki/concepts/attention.md # see related pages | ||
| wiki log append query "How does multi-head attention work?" | ||
| ``` | ||
| ### Maintain Wiki Health | ||
| ```bash | ||
| wiki lint # find broken links, orphans, missing frontmatter | ||
| wiki orphans # pages nobody links to | ||
| 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 | ||
@@ -178,2 +220,3 @@ | ||
| wiki --wiki personal read wiki/index.md # target specific wiki | ||
| wiki search "neural networks" --all # search across all wikis | ||
| ``` | ||
@@ -186,3 +229,3 @@ | ||
| - Node.js >= 18 (or Bun) | ||
| - Git (optional, for version control features) | ||
| - Git (optional but recommended for version control) | ||
@@ -192,6 +235,7 @@ ## Development | ||
| ```bash | ||
| git clone https://github.com/user/llmwiki-cli | ||
| git clone https://github.com/doum1004/llmwiki-cli | ||
| cd llmwiki-cli | ||
| bun install | ||
| bun test | ||
| bun test # 93 tests | ||
| bun run build # bundle to dist/wiki.js | ||
| bun run dev -- --help | ||
@@ -198,0 +242,0 @@ ``` |
Sorry, the diff of this file is too big to display
Network access
Supply chain riskThis module accesses the network.
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
No License Found
LicenseLicense information could not be found.
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
225695
9.11%4
33.33%0
-100%6251
7.44%234
23.16%11
22.22%3
200%