abrez β€Ž commited on
Commit
7d25abb
Β·
1 Parent(s): de90a71

docs: add 5-minute walkthrough for using Knowiki on any local project

Browse files
README.md CHANGED
@@ -135,5 +135,53 @@ knowiki propose --title "feat: Add Webhook runbook" # Opens GitHub PR
135
 
136
  ---
137
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
138
  ## πŸ“„ License
139
  MIT
 
 
135
 
136
  ---
137
 
138
+ ## πŸ’‘ Trying Knowiki on Any Project on Your PC
139
+
140
+ You can use Knowiki on **any project or workspace on your computer** without modifying your project's codebase. Here is how to test it end-to-end in 5 minutes:
141
+
142
+ ### 1. Link the CLI globally
143
+ From your `Knowiki-V1` folder, link the CLI so the `knowiki` command is available everywhere:
144
+ ```bash
145
+ pnpm --filter @knowiki/cli link --global
146
+ ```
147
+
148
+ ### 2. Keep the local API running
149
+ Open a terminal in `Knowiki-V1` and run the API service:
150
+ ```bash
151
+ pnpm dev:api
152
+ ```
153
+ *(Runs on `http://localhost:3000`)*
154
+
155
+ ### 3. Navigate to any project folder
156
+ In a separate terminal, navigate to any repository or codebase on your machine:
157
+ ```bash
158
+ cd C:\path\to\your-other-project
159
+ # or: cd ~/projects/my-app
160
+ ```
161
+
162
+ ### 4. Initialize Knowiki
163
+ Connect your project to any GitHub repository containing intelligence, runbooks, or skills:
164
+ ```bash
165
+ knowiki init https://github.com/spencerpauly/skills-repo
166
+ ```
167
+
168
+ ### 5. What Happens Next
169
+ 1. **Auto-Bootstrapped Meta-Skill**: Knowiki detects your environment and installs the `knowiki-operator` meta-skill into:
170
+ - **Google Antigravity / Gemini**: `.gemini/skills/knowiki/`
171
+ - **Cursor**: `.cursor/rules/knowiki.mdc`
172
+ - **Claude Code**: `.claude/skills/knowiki/`
173
+ 2. **Instant Agent Context**: Your AI agent can now autonomously query, read, and search project rules and skills!
174
+ 3. **Inspect & Materialize**:
175
+ - `knowiki status` β€” View connected intelligence repository and cache state.
176
+ - `knowiki skills list` β€” List all available runbooks.
177
+ - `knowiki skills install <skill-name>` β€” Materialize a skill directly into your agent's skills directory.
178
+ 4. **Collaborate & Propose Changes**:
179
+ - Edit files in `.knowiki/cache/`
180
+ - `knowiki diff` β€” Inspect uncommitted local changes.
181
+ - `knowiki push` / `knowiki propose` β€” Commit directly or open a GitHub Pull Request.
182
+
183
+ ---
184
+
185
  ## πŸ“„ License
186
  MIT
187
+
docs/wiki/05-cli-specification-and-workflows.md CHANGED
@@ -107,3 +107,31 @@ This equips local AI agents to autonomously discover, read, update, push, and pr
107
  | `knowiki skills list` | Lists all available project skills |
108
  | `knowiki skills show <id>` | Renders a skill runbook in the terminal |
109
  | `knowiki skills install <id>` | Materializes canonical skill into agent-native directories |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
107
  | `knowiki skills list` | Lists all available project skills |
108
  | `knowiki skills show <id>` | Renders a skill runbook in the terminal |
109
  | `knowiki skills install <id>` | Materializes canonical skill into agent-native directories |
110
+
111
+ ---
112
+
113
+ ## 6. End-to-End Workflow: Using Knowiki on Any Local Workspace
114
+
115
+ Developers can attach Knowiki to any existing project on their machine:
116
+
117
+ 1. **Globally Link CLI**:
118
+ ```bash
119
+ pnpm --filter @knowiki/cli link --global
120
+ ```
121
+ 2. **Ensure API is running**:
122
+ ```bash
123
+ pnpm dev:api
124
+ ```
125
+ 3. **Navigate to external workspace**:
126
+ ```bash
127
+ cd ~/my-other-project # or C:\Projects\MyOtherApp
128
+ ```
129
+ 4. **Initialize Knowiki connection**:
130
+ ```bash
131
+ knowiki init https://github.com/spencerpauly/skills-repo
132
+ ```
133
+ 5. **Observe automatic bootstrapping**:
134
+ - Meta-skill `.gemini/skills/knowiki/SKILL.md` (or `.cursor/rules/knowiki.mdc` / `.claude/skills/knowiki/`) is written.
135
+ - Remote skills and knowledge are cached in `.knowiki/cache/`.
136
+ - Your local agent immediately has access to search, list, and materialize skills for that workspace.
137
+