Quick Start
Get a Context Nest vault running in under 2 minutes.
Prerequisites
- Node.js 20 or later
- A terminal (macOS, Linux, Windows with WSL or Git Bash)
Steps
- Install the CLI
- Create a vault with a starter recipe
- Add documents to your vault
- Query context for AI agent consumption
By the end, you'll have a versioned, queryable knowledge vault that any AI agent can read.
Working across vaults
You don't have to cd into a vault to use it. The CLI keeps a vault registry that maps a short alias to each vault's path, so you can target any registered vault from any folder:
ctx vault add work ~/vaults/work-kb # register a vault under an alias
ctx vault default work # make it the default
ctx --vault work query "#roadmap" # run against it from anywhere
ctx vault which # show which vault the CLI would use, and why
Published-only by default
Retrieval returns published documents only by default — drafts you're still working on stay out of agent context until you publish them. When you do want to see drafts (for example while authoring), add --include-drafts:
ctx query "#roadmap" # published documents only
ctx query "#roadmap" --include-drafts # include drafts too
Consent on writes
Every command that writes asks before it does and then prints the exact list of files it touched. Preview any write without changing anything using --dry-run; in a non-interactive shell (agents, CI), destructive commands refuse unless you pass --yes or --force.
Related pages
- Create a VaultStarter recipes scaffold a vault with documents, packs, and agent instructions tailored to a role:
- Install the ctx CLIThe package installs with a flattened dependency tree — its runtime dependencies are bundled/flattened so a global install pulls a self-contained CLI…
- Query ContextContext Nest gives you two ways to pull from your vault: ctx resolve for a metadata list of matches, and ctx query for full, graph-aware context retrieval.
- Add DocumentsThis creates nodes/api-design.md from a frontmatter template as version 1, and regenerates the index. Tags accept a comma- or space-separated list; you…
- PromptOwl DocumentationWelcome to the documentation for PromptOwl and Context Nest — the open protocol and hosted platform for giving AI agents structured, versioned, governed…