Skip to content
Back to search

wiki

Indexed knowledge bases with command-line tools for agents.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

Its scripts were only partly scanned.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/plasma-ai/wiki with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/plasma-ai/wiki'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/plasma-ai--wiki/badge.svg)](/listings/plasma-ai--wiki)

HTML

<a href="/listings/plasma-ai--wiki"><img src="/api/listings/plasma-ai--wiki/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Install the `wiki` package from PyPI:

pip install plasma-wiki

Use `pipx install` or `uv tool install` to install the package in an isolated environment.

Skill

Install the skill for your agent via the plugin marketplace (Claude Code and Codex):

# Claude Code
/plugin marketplace add plasma-ai/plugins
/plugin install wiki@plasma

# Codex
codex plugin marketplace add plasma-ai/plugins
codex plugin add wiki@plasma

Another install route is from the CLI, which copies (or symlinks) the skill into `~/.claude/skills` and `~/.agents/skills` (add `--project` for the current project only):

wiki install [--link]

After upgrading the package, re-run `wiki install` to refresh the copied skill (pass `--link` for symlinked install).

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/plugin.json · Manifest · 14 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. {
  2. "name": "wiki",
  3. "displayName": "Wiki",
  4. "version": "1.9.0",
  5. "description": "Indexed knowledge bases with command-line tools for agents.",
  6. "author": {
  7. "name": "Plasma AI",
  8. "email": "eng@plasma.ai",
  9. "url": "https://plasma.ai"
  10. },
  11. "skills": ["./wiki/skills"],
  12. "repository": "https://github.com/plasma-ai/wiki",
  13. "keywords": ["wiki"]
  14. }
README.md · README · 309 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # wiki
  2. [![license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/plasma-ai/wiki/blob/main/LICENSE)
  3. [![build](https://github.com/plasma-ai/wiki/actions/workflows/build.yaml/badge.svg)](https://github.com/plasma-ai/wiki/actions/workflows/build.yaml)
  4. [![docs](https://github.com/plasma-ai/wiki/actions/workflows/docs.yaml/badge.svg)](https://github.com/plasma-ai/wiki/actions/workflows/docs.yaml)
  5. [![lint](https://github.com/plasma-ai/wiki/actions/workflows/lint.yaml/badge.svg)](https://github.com/plasma-ai/wiki/actions/workflows/lint.yaml)
  6. [![tests](https://github.com/plasma-ai/wiki/actions/workflows/tests.yaml/badge.svg)](https://github.com/plasma-ai/wiki/actions/workflows/tests.yaml)
  7. [![codecov](https://codecov.io/gh/plasma-ai/wiki/branch/main/graph/badge.svg?token=D8LJA7CZ2K)](https://codecov.io/gh/plasma-ai/wiki)
  8. [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
  9. Indexed knowledge bases with command-line tools for agents.
  10. A wiki keeps project knowledge as plain markdown, indexed at every level by
  11. `_index.md` files, read by consulting the index and opening only the pages that
  12. a task needs. Andrej Karpathy named this shape the
  13. [LLM Wiki](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f)
  14. pattern, and Google's
  15. [Open Knowledge Format](https://cloud.google.com/blog/products/data-analytics/how-the-open-knowledge-format-can-improve-data-sharing)
  16. describes a standardized format for such markdown knowledge bases. Most
  17. approaches leave a great deal of structuring for agents to maintain by hand;
  18. here a deterministic CLI generates the indexes and cross-links and auto-resolves
  19. the generated region of `_index.md` merges when parallel edits collide —
  20. authored content below the delimiter still merges (and can conflict) like any
  21. other text — so content is the only judgment call.
  22. ______________________________________________________________________
  23. **Source**:
  24. [https://github.com/plasma-ai/wiki](https://github.com/plasma-ai/wiki)
  25. **Package**:
  26. [https://pypi.org/project/plasma-wiki/](https://pypi.org/project/plasma-wiki/)
  27. **Documentation**: [https://docs.plasma.ai/wiki](https://docs.plasma.ai/wiki)
  28. ______________________________________________________________________
  29. ## Installation
  30. Install the `wiki` package from PyPI:
  31. ```bash
  32. pip install plasma-wiki
  33. ```
  34. Use `pipx install` or `uv tool install` to install the package in an isolated
  35. environment.
  36. ### Skill
  37. Install the skill for your agent via the plugin marketplace (Claude Code and
  38. Codex):
  39. ```bash
  40. # Claude Code
  41. /plugin marketplace add plasma-ai/plugins
  42. /plugin install wiki@plasma
  43. # Codex
  44. codex plugin marketplace add plasma-ai/plugins
  45. codex plugin add wiki@plasma
  46. ```
  47. Another install route is from the CLI, which copies (or symlinks) the skill into
  48. `~/.claude/skills` and `~/.agents/skills` (add `--project` for the current
  49. project only):
  50. ```bash
  51. wiki install [--link]
  52. ```
  53. After upgrading the package, re-run `wiki install` to refresh the copied skill
  54. (pass `--link` for symlinked install).
  55. ## Usage
  56. A wiki is a tree of markdown files linked together by `_index.md` files. Each
  57. folder becomes a section, and each markdown file becomes an entry. Wikis are
  58. designed to be read and written by both humans and agents: humans author content
  59. in Obsidian (or any editor), and agents query the wiki through the CLI to ground
  60. their work in project-specific knowledge.
  61. Every wiki root carries a `.wiki/` directory — the tool's namespace, holding
  62. `settings.json` (the file that declares the root; `wiki init` writes it and
  63. `wiki update` restores a missing one), the derived word counts and ranked
  64. full-text search caches, and the staged Obsidian config. Page, folder, and wiki
  65. names are lenient by default: spaces, dashes, mixed case, and unicode are all
  66. fine. Only characters that would break the wiki's structure — its path, link,
  67. and index syntax — are rejected, along with leading dots (hidden files) and the
  68. reserved `_index` name. A wiki can opt into stricter rules, such as ASCII-only
  69. or identifier-style names, through the `naming` block in `.wiki/settings.json`;
  70. `wiki lint` flags any name that violates the policy. Whole subtrees can be
  71. excluded from indexing with gitignore-style globs in `exclude.patterns` —
  72. excluded paths are never walked or linted, though `wiki read` still serves them.
  73. Prose wikilinks stay inside the wiki unless `links.external` lists folders
  74. outside it, as paths relative to the wiki root (`../src`, `../math`): a `./` or
  75. `../` link, read from the wiki root like every other link, may then target a
  76. file or another wiki's page under a listed folder, whose entry is the link's
  77. prefix. The allowlist is a lint rule alone — `wiki lint` checks such links in
  78. place, while `wiki read` and every other command stay confined to the wiki root.
  79. Frontmatter timestamps default to UTC in ISO-8601. To change them, set a
  80. timezone (any IANA name) and format (a strftime string) under `timestamp` in
  81. `.wiki/settings.json`. The stamps are tool-owned: `created:` is written when a
  82. file gains frontmatter and kept from then on, and `updated:` is rewritten on
  83. every write that changes content (a write that only normalizes CRLF line endings
  84. leaves it untouched). A hand edit goes undetected unless the value stops parsing
  85. under the configured format — `wiki lint` fails an unparseable stamp.
  86. Display names are path-derived: `wiki update` owns each entry's `name:`
  87. frontmatter and rewrites the H1 heading to match. An optional authored `title:`
  88. field — on any index or page — overrides the H1 while `name` stays tool-owned;
  89. set `title: null` (or delete the line) to unset it. When a page first gains
  90. frontmatter, `wiki update` seeds `title:` from its existing H1, so the authored
  91. heading survives adoption; a page with no H1 gains the path-derived heading and
  92. no title. Setting `titles.required` in `.wiki/settings.json` demands an authored
  93. title everywhere: `wiki update` seeds a `title: null` placeholder on every entry
  94. missing one and `wiki lint` fails each placeholder until a title is authored.
  95. Word counts shown by `wiki map` are computed from page bodies and cached in
  96. `.wiki/cache/word_counts.json` under the wiki root — never stored in
  97. frontmatter, so editing a page dirties nothing else. The cache directory ignores
  98. itself via its own `.gitignore` and can be deleted at any time; it is rebuilt on
  99. demand. In the map, a page shows its own count and a folder shows `page/tree`
  100. (its index's words over the subtree total), abbreviated with `k`/`m` suffixes
  101. past a thousand. Descriptions print in full by default — `--desc-limit` (or the
  102. `map.desc_limit` setting) caps them to a character budget, and `-1` forces no
  103. truncation — while `wiki map --stat` sizes the dump (lines, chars, words)
  104. without printing it. The map's indent unit and truncation marker are
  105. configurable via `map.indent` and `map.ellipsis` in `.wiki/settings.json`.
  106. Ranked search uses the same self-ignored cache directory. `wiki search` builds
  107. an SQLite FTS5 index on first use and refreshes added, changed, and removed
  108. Markdown pages before each query. BM25 ranking weights titles, descriptions,
  109. headings, and frontmatter tags above body prose; the default query form safely
  110. combines terms with AND, while `--prefix`, `--tag`, `--raw`, and `--json` cover
  111. agent workflows.
  112. ### CLI
  113. Use the `/wiki` skill to manage wikis, or drive the `wiki` CLI directly.
  114. Initialize a wiki in the current project and configure integrations:
  115. - `wiki init` — scaffold a new wiki with a root index
  116. - `wiki config` — install Obsidian plugins and the git merge driver
  117. The merge driver itself lives in each clone's local git config; the committed
  118. `.gitattributes` only names it, so every contributor runs `wiki config` once
  119. after cloning.
  120. A wiki may define a `.wiki/wiki.py` hook — a custom `Wiki` subclass the tool
  121. loads to change indexing or formatting. Because the hook runs code with your
  122. privileges, `wiki` refuses to load one from a wiki you have not trusted (every
  123. command that resolves the wiki fails, naming the hook) and points you at:
  124. - `wiki trust` — authorize the enclosing wiki to run its `.wiki/wiki.py`
  125. Run it once from inside a wiki whose contents you have vetted; it records the
  126. wiki's resolved root in `~/.wiki/settings.json` (override the config home with
  127. `WIKI_CONFIG_DIR`). A wiki with no hook needs no trust. Never trust a wiki
  128. cloned from an untrusted source without first reading its `.wiki/wiki.py`.
  129. Maintain indexes as files are added and removed:
  130. - `wiki lint` — validate structure and flag issues
  131. - `wiki update` — sync index links with the filesystem
  132. - `wiki new` — create an indexed folder with an authored desc and content
  133. `wiki lint` exits 1 on issues and 0 on a clean wiki (soft notes go to stderr and
  134. never affect the exit code — a stale wikilink in prose is a note (an issue under
  135. the opt-in `lint.strict` setting), while a broken link in a generated index
  136. block, a prose link naming a folder rather than its `_index` page, a `./`,
  137. `../`, or absolute prose link that lands inside the wiki, a `./` or `../` prose
  138. link outside every allowlisted folder, or frontmatter a strict YAML reader
  139. rejects, is an issue). A note kind that repeats prints as one count line, such
  140. as `12 indexes have empty content`; `wiki lint --full` lists each note. Scripts
  141. should read `wiki lint --json` — one JSON document on stdout listing every issue
  142. and note with a `severity` and `kind` — rather than parse the prose; the exit
  143. code is unchanged. A page that must display otherwise-flagged content — sample
  144. conflict markers, stale link examples — wraps those lines in a
  145. `<!-- start: no-lint -->` ... `<!-- end: no-lint -->` region, which suppresses
  146. the positional rules, notes included, for just that span.
  147. Browse structure, search across content, and read entries:
  148. - `wiki map` — print an indented tree overview
  149. - `wiki search` — rank relevant pages with SQLite FTS5
  150. - `wiki match` — match content with regex
  151. - `wiki read` — read a named entry
  152. Commands other than `init` operate on the enclosing wiki when run from inside
  153. one (the root is the ancestor declaring itself with `.wiki/settings.json`; an
  154. undeclared index tree resolves to its outermost `_index.md`, unless the tree
  155. encloses a declared root — then resolution refuses and directs you to that
  156. root), or else on the `wiki/` folder under the current directory; pass `--path`
  157. to target another wiki. `map`, `search`, `match`, `update`, and `lint` accept an
  158. optional name argument to restrict scope to a subtree. Run `wiki --help` and
  159. `wiki <command> --help` for full option descriptions.
  160. ### Formatters
  161. The `***` delimiter and `[[wikilinks]]` are load-bearing syntax:
  162. mdformat/prettier-style hooks rewrite `***` to `---` and backslash-escape the
  163. brackets, demoting the generated link block to plain text. `wiki update` repairs
  164. a mangled index and `wiki lint` names the damage signatures (escaped wikilinks,
  165. a thematic break standing where `***` belongs), but don't rely on the repair —
  166. pick a lane.
  167. For mdformat, add the [mdformat-wiki](https://pypi.org/project/mdformat-wiki/)
  168. plugin, which teaches it to leave wikilinks, frontmatter, and the `***`
  169. delimiter untouched, so wiki faces round-trip byte-identically. Under
  170. pre-commit:
  171. ```yaml
  172. - id: mdformat
  173. additional_dependencies: [mdformat-wiki]
  174. ```
  175. If the hook already lists `mdformat-frontmatter`, remove it — both plugins
  176. register a frontmatter renderer and whichever the environment discovers first
  177. wins; when `mdformat-frontmatter` wins, it re-serializes the YAML (quoting
  178. values, blanking `null`s) instead of leaving it untouched.
  179. For formatters with no plugin lane, exclude the wiki root instead — for
  180. prettier, add it to `.prettierignore`:
  181. ```text
  182. wiki/
  183. ```
  184. ## Development
  185. ### Install
  186. Run `install.sh` in the package root. With no environment active it creates and
  187. uses a local `.venv`; with one active (e.g. pyenv) it installs into that
  188. environment (editable), without recreating it:
  189. ```bash
  190. ./install.sh --all-extras --groups=test,lint,type
  191. ```
  192. Run `./install.sh --help` for all options. Alternatively, run
  193. `uv sync --all-extras --group test --group lint --group type` and
  194. `uv run pre-commit install` to set up the environment manually.
  195. Installing a dependency as editable (e.g. a sibling package) is left to the
  196. caller: `uv pip install --editable <path>`.
  197. With an editable install, `wiki install --link` symlinks the bundled skill into
  198. the agent skill directories instead of copying it, so skill edits apply without
  199. re-running the install.
  200. Once installed, run tools with `uv run --no-sync <command>`, or activate the
  201. environment first (`source .venv/bin/activate`).
  202. ### Tests
  203. Run the test suite:
  204. ```bash
  205. pytest .
  206. ```
  207. ### Linting
  208. Run linters and formatters:
  209. ```bash
  210. pre-commit run --all-files
  211. ```
  212. ### Contributing
  213. The contribution workflow, repository conventions, and release process (version
  214. sources, tagging, CI guard) are documented in:
  215. - Contribution workflow (organization-wide):
  216. [CONTRIBUTING.md](https://github.com/plasma-ai/.github/blob/main/CONTRIBUTING.md)
  217. - Repository conventions:
  218. [AGENTS.md](https://github.com/plasma-ai/wiki/blob/main/AGENTS.md)
  219. - Release process (organization-wide):
  220. [RELEASING.md](https://github.com/plasma-ai/.github/blob/main/RELEASING.md)
  221. Pull requests should be branched from `dev`, not `main`, and opened against
  222. `dev` — `main` only advances at releases.
  223. ## Third-Party Software
  224. `wiki` sets up the
  225. [Front Matter Title](https://github.com/snezhig/obsidian-front-matter-title)
  226. Obsidian plugin by Snezhig, which displays each note's `name` frontmatter as its
  227. title. The plugin is licensed GPL-3.0; `wiki init`/`wiki config` download
  228. version 4.1.0 from the upstream GitHub release at setup time rather than
  229. redistributing it.
  230. `wiki` also bundles its own Wiki Root Links Obsidian plugin, licensed Apache-2.0
  231. with the package: `wiki init`/`wiki config` copy it into the vault so Obsidian
  232. reads a `./` or `../` link from the wiki root as `wiki lint` does, never as a
  233. note in the vault, and a click on one draws a notice or opens a markdown target
  234. in a sibling wiki's own registered vault.
  235. ## License
  236. Licensed under the Apache License 2.0 — see
  237. [LICENSE](https://github.com/plasma-ai/wiki/blob/main/LICENSE).
  238. Copyright © 2026 Plasma AI

Version history

  • v1.9.010/26/2026

  • v1.8.010/24/2026

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.