Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ OpenWiki is a CLI that writes and maintains a wiki for your codebase or your per
**OpenWiki gives you:**

- **Agent-written docs** that stay accurate, generated by a [Deep Agents](https://github.com/langchain-ai/deepagentsjs) documentation agent.
- **Two modes:** a `code` wiki for a repository, or a `personal` wiki for your own knowledge.
- **Three modes:** a `code` wiki for a repository, a `company` brain for organizational knowledge, or a `personal` wiki for your own knowledge.
- **Thirteen model providers** out of the box, from OpenAI and Anthropic to Bedrock, Gemini, and any OpenAI-compatible gateway.
- **Coding-agent integrations** for Codex and Claude Code, using the host's model and repository tools.
- **Grounded Claims** that track material facts back to versioned source evidence and surface them when the evidence changes.
Expand Down Expand Up @@ -102,14 +102,15 @@ Before an update, OpenWiki checks those evidence versions. If source lines chang

Grounded Claims currently apply to repository code wikis and repository evidence. Connector-derived facts, including LangSmith-only observations, are not claimed.

## Two modes
## Three modes

OpenWiki runs in one of two modes. Bare `openwiki`, `openwiki --init`, and `openwiki --update` default to **code** mode; add the `personal` positional (or `--mode personal`) for the personal brain.
Stratiki runs in one of three modes. Bare `stratiki`, `stratiki --init`, and `stratiki --update` default to **code** mode; add the `company` or `personal` positional (or `--mode company` / `--mode personal`) for the company or personal brain.

| Mode | Documents | Writes to | Get started |
| -------------------- | ---------------------- | ----------------------- | -------------------------- |
| **Code** _(default)_ | The current repository | `openwiki/` in the repo | `openwiki --init` |
| **Personal** | Your connected sources | `~/.openwiki/wiki` | `openwiki personal --init` |
| **Code** _(default)_ | The current repository | `openwiki/` in the repo | `stratiki --init` |
| **Company** | Company knowledge | `~/.stratiki/wiki` | `stratiki company --init` |
| **Personal** | Your connected sources | `~/.openwiki/wiki` | `stratiki personal --init` |

By default the CLI stays open after a run so you can send follow-up messages. Add `-p` / `--print` for a one-shot, non-interactive run that prints the final output and exits. `--init` and `--update` auto-exit on success in an interactive terminal, so the same command works one-shot or interactively.

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@
}
},
"devDependencies": {
"@changesets/cli": "^3.0.1",
"@eslint/js": "^10.0.1",
"@types/better-sqlite3": "^7.6.12",
"@types/jsdom": "^28.0.3",
Expand Down
Loading