Back to Openviking

@openviking/cli

npm/cli/README.md

0.3.172.6 KB
Original Source

@openviking/cli

Native CLI for OpenViking — an agent-native context database for AI workflows.

Store, search, and retrieve context (memories, resources, embeddings) across conversations and agents.

Install

bash
npm i -g @openviking/cli

This installs the ov binary for your platform (macOS, Linux, Windows).

Alternative install methods

bash
# via curl
curl -fsSL https://openviking.tos-cn-beijing.volces.com/cli/install.sh | bash

# one-shot with npx
npx @openviking/cli --help

Quick start

bash
# Check connectivity
ov health

# Store context
ov add-resource ./notes.md
ov add-memory "key insight from today's debugging session"

# Retrieve context
ov find "what did I learn about caching?"
ov ls
ov read /path/to/resource

# Semantic search
ov search "authentication flow"
ov grep "TODO"

Commands

Data

CommandDescription
add-resourceAdd files or URLs into OpenViking
add-memoryStore a memory in one shot
add-skillAdd a skill from a directory or SKILL.md
lsList directory contents
treeHierarchical tree view
readRead full file content
abstractBrief summary (L0)
overviewMedium detail (L1)
writeWrite or append text content
findSemantic retrieval with scoring
searchContext-aware retrieval (experimental)
grepPattern search with regex
globFile glob pattern search
rmRemove a resource or directory
mvMove or rename a resource
statGet resource metadata
getDownload file to local path
sessionManage sessions
export / importBackup and restore as .ovpack

Interactive

CommandDescription
tuiInteractive file explorer
chatChat with vikingbot agent

Status

CommandDescription
healthQuick health check
statusShow server components status
configConfiguration management
versionShow CLI and server version
taskTrack async processing tasks

Supported platforms

PlatformArchitecturePackage
macOSApple Silicon@openviking/cli-darwin-arm64
macOSIntel@openviking/cli-darwin-x64
Linuxx64@openviking/cli-linux-x64
LinuxARM64@openviking/cli-linux-arm64
Windowsx64@openviking/cli-win32-x64

License

Apache-2.0