Skip to content

Commit 72d85d1

Browse files
committed
readme: split quick start into simple (one-liner) and advanced (yaml/daemon)
Simple path: pip install, export env vars, oikb sync ./docs --kb-id Advanced path: oikb init → oikb daemon. No yaml needed for basic use.
1 parent 9d0a6ae commit 72d85d1

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,18 @@ pip install oikb
1313
export OPEN_WEBUI_URL=http://localhost:3000
1414
export OPEN_WEBUI_API_KEY=sk-your-api-key
1515

16-
# Generate a config file
17-
oikb init
16+
# Sync a directory
17+
oikb sync ./docs --kb-id your-kb-id
1818

19-
# Preview what would sync
20-
oikb sync --dry-run
21-
22-
# Run the sync
23-
oikb sync
19+
# Sync a GitHub repo
20+
oikb sync github:owner/repo --kb-id your-kb-id
2421

25-
# Or start the daemon for scheduled sync
26-
oikb daemon
22+
# Preview first (no upload)
23+
oikb sync ./docs --kb-id your-kb-id --dry-run
2724
```
2825

26+
For multi-source, scheduled sync, or daemon mode — run `oikb init` to generate a `.oikb.yaml` config file, then `oikb daemon`.
27+
2928
## Commands
3029

3130
| Command | Description |

0 commit comments

Comments
 (0)