WIKI · Adapter
wiki-fs
via Local filesystem
Markdown + YAML frontmatter pages. Atomic writes, naive search.
@openagentry/adapter-wiki-fs npm → — · Install
Use it
# Install
$ npm install @openagentry/adapter-wiki-fs
# Or in a workspace registered with the CLI
$ npx agentry init @openagentry/adapter-wiki-fs— · Default export
Pattern: eager
The default export is always a fully-instantiated adapter — env reads happen at
module load and have safe fallbacks. import x from '@openagentry/adapter-wiki-fs'
gives you a working adapter immediately.
import default_ from '@openagentry/adapter-wiki-fs';
// → wikiAdapter — category: 'wiki', id: 'wiki-fs'— · Environment
Configuration
| Variable | Notes |
|---|---|
| OA_WIKI_FS_WORKSPACE | Required. |
| OA_WIKI_FS_PROJECT | Optional. |
— · Reported capabilities
What the manifest says
agentry capabilities --json reports these flags from
the package's openagentry.capabilities manifest block.
- search
- naive-substring
- frontmatter
- true
- atomicWrites
- true
— · Failure modes
Error codes
6 stable codes this adapter throws. Each has a one-line resolution.
-
E_WIKI_FS_NOT_FOUNDWiki page not found at the requested path. -
E_WIKI_FS_OUT_OF_VAULTPath resolved outside the configured vault root. -
E_WIKI_FS_NO_PROJECT_VAULTA `project/` path was used but no `projectVaultPath` is configured. -
E_WIKI_FS_PERMISSIONFilesystem permission denied. -
E_WIKI_FS_PARSEPage frontmatter could not be parsed as YAML. -
E_WIKI_FS_SCHEMAInput failed Zod validation.