@autonav/core
v1.1.3
Published
CLI tools and Claude SDK Adapter for Autonav navigators
Downloads
167
Maintainers
Readme
@autonav/core
CLI and SDK adapter for knowledge navigators.
Install
npm install -g @autonav/coreCLI
# Create a navigator
autonav init my-docs
# Query it
autonav query my-docs "How do I deploy?"
# Interactive chat mode
autonav chat my-docsKnowledge Packs
Knowledge packs are starter templates with pre-built documentation and configuration for specific domains.
# Install from a pack server
autonav init my-nav --pack platform-engineering
# Install from GitHub (full URL)
autonav init my-nav --pack https://github.com/owner/repo/tree/main/packs/my-pack
# Install from GitHub (shorthand)
autonav init my-nav --pack github:owner/repo/packs/my-pack
# Install from GitHub via SSH (uses your SSH keys)
autonav init my-nav --pack [email protected]:owner/repo/packs/my-pack
# Install specific version
autonav init my-nav --pack github:owner/repo/packs/[email protected]
# Install from local file
autonav init my-nav --pack-file ./my-pack.tar.gzA knowledge pack must contain:
metadata.json- Pack name and versionsystem-configuration.mdand/orknowledge/directory
Note: Currently, navigators support one knowledge pack. Multiple packs may be supported in a future release.
Programmatic use
import { ClaudeAdapter } from "@autonav/core";
const adapter = new ClaudeAdapter();
const nav = await adapter.loadNavigator("./my-docs");
const response = await adapter.query(nav, "How do I deploy?");
console.log(response.answer);
console.log(response.sources);Navigator structure
my-docs/
├── config.json # Name, version, settings
├── CLAUDE.md # System prompt
├── knowledge-base/ # Your documentation
└── .claude/
└── plugins.json # Plugin configurationResponse format
{
"query": "How do I deploy?",
"answer": "Run kubectl apply -f prod.yaml",
"sources": [
{
"filePath": "deployment.md",
"excerpt": "kubectl apply -f prod.yaml"
}
],
"confidence": "high"
}Environment
ANTHROPIC_API_KEY - Required for queries.
FAQ
Why would I use this instead of just using Claude Code directly?
You should keep using Claude Code! Autonav is designed to augment Claude Code, not replace it.
The recommended workflow is:
- Create a navigator with
autonav init - Work with it using Claude Code (
cd my-nav && claude) - Use
autonav querywhen you need programmatic access
Autonav is batteries-included for navigators - it standardizes the concept so navs are portable and integratable:
- Portable: Your nav is just a directory - run it anywhere Claude Code runs, or via the SDK on servers and CI/CD pipelines
- Shareable: Knowledge packs let you share curated context with others
- Programmable:
autonav querygives consistent JSON output for automation - Batteries-included: Plugins, validation, and scaffolding designed specifically for knowledge navigators
Claude Code is general-purpose and extensible too, but Autonav gives you the nav-specific tooling out of the box.
