ov-search-context

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

OpenViking (OV) context searching

OpenViking (OV) 上下文搜索

The
ov search
command performs context-aware retrieval across all memories and resources in OpenViking — combining semantic understanding with directory recursive retrieval to find the most relevant context for any query.
ov search
命令可在OpenViking的所有记忆和资源中执行上下文感知检索——结合语义理解与目录递归检索,为任意查询找到最相关的上下文。

Table of Content

目录

  • When to Use
  • Sub-commands for search
    • List directories (
      ov ls
      )
    • Tree view (
      ov tree
      )
    • Semantic Search (
      ov find
      )
    • Content Pattern Search (
      ov grep
      )
    • File Glob Search (
      ov glob
      )
    • Full content read (
      ov read
      )
    • Get overview (
      ov overview
      )
    • Get Abstract (
      ov abstract
      )
  • Prerequisite
  • 使用场景
  • 搜索子命令
    • 列出目录(
      ov ls
    • 树形视图(
      ov tree
    • 语义搜索(
      ov find
    • 内容模式搜索(
      ov grep
    • 文件通配符搜索(
      ov glob
    • 读取完整内容(
      ov read
    • 获取概览(
      ov overview
    • 获取摘要(
      ov abstract
  • 前置条件

When to Use

使用场景

  • Finding specific information within imported resources or saved memories
  • Retrieving context about topics, APIs, or patterns previously added
  • Searching across project documentation, code, and learnings
  • When an agent needs to reference previously stored knowledge
note: cli command can be outdated, when sees error, use
--help
to get latest usage
  • 在已导入的资源或已保存的记忆中查找特定信息
  • 检索先前添加的主题、API或模式相关的上下文
  • 跨项目文档、代码和学习资料进行搜索
  • 当Agent需要参考先前存储的知识时
注意:CLI命令可能会过时,若遇到错误,请使用
--help
获取最新使用方法

Sub-commands for search

搜索子命令

List Contents (
ov ls
)

列出内容(
ov ls

Browse directory structure:
bash
undefined
浏览目录结构:
bash
undefined

List root directory

列出根目录

ov ls
ov ls

List specific directory

列出指定目录

ov ls viking://resources/my-project/docs/
ov ls viking://resources/my-project/docs/

Simple path output (only uris, no metadata)

简单路径输出(仅显示URI,无元数据)

ov ls viking://resources --simple
ov ls viking://resources --simple

Show hidden files

显示隐藏文件

ov ls viking://resources --all
ov ls viking://resources --all

Control output limits (default 256)

控制输出数量限制(默认256)

ov ls viking://resources --node-limit 50
ov ls viking://resources --node-limit 50

Control abstract info length limit for each node (default 256)

控制每个节点的摘要信息长度限制(默认256)

ov ls viking://resources --abs-limit 128
undefined
ov ls viking://resources --abs-limit 128
undefined

Tree View (
ov tree
)

树形视图(
ov tree

Visualize directory hierarchy:
bash
undefined
可视化目录层级:
bash
undefined

Show tree structure

显示树形结构

ov tree viking://resources
ov tree viking://resources

Control depth limits (default 3)

控制深度限制(默认3)

ov tree viking://resources --level-limit 2
ov tree viking://resources --level-limit 2

Control node limits

控制节点数量限制

ov tree viking://resources --node-limit 100 --abs-limit 128
ov tree viking://resources --node-limit 100 --abs-limit 128

Show all files including hidden

显示所有文件(包括隐藏文件)

ov tree viking://resources --all
undefined
ov tree viking://resources --all
undefined

Semantic find (
ov find
)

语义查找(
ov find

Find method with semantic relevance ranking:
bash
undefined
基于语义相关性排序的查找方法:
bash
undefined

Basic find across all context

基础查找,覆盖所有上下文

ov find "how to handle API rate limits"
ov find "how to handle API rate limits"

Find within specific URI scope

在指定URI范围内查找

ov find "authentication flow" --uri "viking://resources/my-project"
ov find "authentication flow" --uri "viking://resources/my-project"

Limit results and set relevance score threshold

限制结果数量并设置相关度分数阈值

ov find "error handling" --node-limit 5 --threshold 0.3
undefined
ov find "error handling" --node-limit 5 --threshold 0.3
undefined

Content Pattern Search (
ov grep
)

内容模式搜索(
ov grep

Literal pattern matching:
bash
undefined
字面模式匹配:
bash
undefined

Find exact text pattern (Note: this is expensive, and suggest within specific small URI scope)

查找精确文本模式(注意:此操作开销较大,建议在特定小URI范围内执行)

ov grep "viking://resources" "TODO:" --uri "viking://resources/my-project"
ov grep "viking://resources" "TODO:" --uri "viking://resources/my-project"

Case-insensitive search

大小写不敏感搜索

ov grep "viking://resources" "API_KEY" --ignore-case --uri "viking://resources/my-project"
ov grep "viking://resources" "API_KEY" --ignore-case --uri "viking://resources/my-project"

Limit results and set node limit

限制结果数量和节点数量

ov grep "viking://resources" "API_KEY" --node-limit 5 --uri "viking://resources/my-project"
undefined
ov grep "viking://resources" "API_KEY" --node-limit 5 --uri "viking://resources/my-project"
undefined

File Glob Search (
ov glob
)

文件通配符搜索(
ov glob

File path pattern matching:
bash
undefined
文件路径模式匹配:
bash
undefined

Find all markdown files (Note: this is expensive, and suggest within specific small URI scope)

查找所有markdown文件(注意:此操作开销较大,建议在特定小URI范围内执行)

ov glob "**/*.md" --uri "viking://resources/my-project"
ov glob "**/*.md" --uri "viking://resources/my-project"

Limit results and set node limit

限制结果数量和节点数量

ov glob "**/*.md" --uri "viking://resources/my-project" --node-limit 5
undefined
ov glob "**/*.md" --uri "viking://resources/my-project" --node-limit 5
undefined

Read File Content (
ov read
)

读取文件内容(
ov read

Retrieve full content (L0-L2 layer):
bash
undefined
检索完整内容(L0-L2层级):
bash
undefined

Read full content

读取完整内容

ov read viking://resources/docs/api/api-1.md
ov read viking://resources/docs/api/api-1.md

Read first 10 lines of api-2.md

读取api-2.md的前10行

ov read viking://resources/docs/api/api-2.md | head -n 10
ov read viking://resources/docs/api/api-2.md | head -n 10

Read abstract (L0 - quick summary)

读取摘要(L0 - 快速总结)

ov abstract viking://resources/docs/api/ ov read viking://resources/docs/api/.abstract.md
ov abstract viking://resources/docs/api/ ov read viking://resources/docs/api/.abstract.md

Read overview (L1 - key points)

读取概览(L1 - 关键点)

ov overview viking://resources/docs/api/ ov read viking://resources/docs/api/.overview.md
undefined
ov overview viking://resources/docs/api/ ov read viking://resources/docs/api/.overview.md
undefined

Combining Search

组合搜索

Use search results to guide further actions:
bash
ov ls viking://resources/
利用搜索结果指导后续操作:
bash
ov ls viking://resources/

Search for relevant files

搜索相关文件

ov search "authentication" --uri "viking://resources/project-A"
ov search "authentication" --uri "viking://resources/project-A"

Get overview for context

获取上下文概览

ov overview viking://resources/project-A/backend
ov overview viking://resources/project-A/backend

Decide to read specific content

决定读取特定内容

ov read viking://resources/project-A/backend/auth.md
undefined
ov read viking://resources/project-A/backend/auth.md
undefined

Prerequisites

前置条件

  • CLI configured:
    ~/.openviking/ovcli.conf
  • Resources or memories previously added to OpenViking
  • 已配置CLI:
    ~/.openviking/ovcli.conf
  • 已向OpenViking添加资源或记忆