searching-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
  • Search Modes
    • Context-Aware Search (
      ov search
      )
    • Content Pattern Search (
      ov grep
      )
    • File Glob Search (
      ov glob
      )
  • Search Options
    • Result Control
    • Scope Control
    • Session-Aware Search
  • Output
  • Other Utilities
    • List Contents (
      ov ls
      )
    • Tree View (
      ov tree
      )
    • Read File Content (
      ov read
      )
  • Agent Best Practices
    • Choosing Search Methods
    • Query Formulation
    • Combining with Other Commands
  • Prerequisite
  • 使用场景
  • 搜索模式
    • 上下文感知搜索(
      ov search
    • 内容模式搜索(
      ov grep
    • 文件通配符搜索(
      ov glob
  • 搜索选项
    • 结果控制
    • 范围控制
    • 会话感知搜索
  • 输出
  • 其他实用工具
    • 列出内容(
      ov ls
    • 树形视图(
      ov tree
    • 读取文件内容(
      ov read
  • Agent最佳实践
    • 选择搜索方法
    • 查询表述
    • 与其他命令结合使用
  • 前提条件

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
获取最新用法

Search Modes

搜索模式

Context-Aware Search (
ov search
)

上下文感知搜索(
ov search

Primary search method with session context awareness:
bash
undefined
具备会话上下文感知的主要搜索方法:
bash
undefined

Basic search across all context

跨所有上下文进行基础搜索

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

Search within specific URI scope

在特定URI范围内搜索

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

Limit results and set threshold

限制结果数量并设置阈值

ov search "error handling" --limit 5 --threshold 0.7
undefined
ov search "error handling" --limit 5 --threshold 0.7
undefined

Content Pattern Search (
ov grep
)

内容模式搜索(
ov grep

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

Search for exact text pattern

搜索精确文本模式

ov grep "viking://resources" "TODO:"
ov grep "viking://resources" "TODO:"

Case-insensitive search

不区分大小写的搜索

ov grep "viking://resources" "API_KEY" --ignore-case
undefined
ov grep "viking://resources" "API_KEY" --ignore-case
undefined

File Glob Search (
ov glob
)

文件通配符搜索(
ov glob

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

Find all markdown files

查找所有markdown文件

ov glob "**/*.md"
ov glob "**/*.md"

Find Python files in specific directory

在特定目录中查找Python文件

ov glob --uri="viking://user/" "**/*.md"
undefined
ov glob --uri="viking://user/" "**/*.md"
undefined

Search Options

搜索选项

Result Control

结果控制

bash
undefined
bash
undefined

Limit number of results

限制结果数量

ov search "authentication" --limit 5
ov search "authentication" --limit 5

Set minimum relevance threshold (0.0-1.0)

设置最低相关性阈值(0.0-1.0)

ov search "deployment" --threshold 0.8
ov search "deployment" --threshold 0.8

Combine limit and threshold

同时设置结果数量限制和阈值

ov search "monitoring" --limit 10 --threshold 0.7
undefined
ov search "monitoring" --limit 10 --threshold 0.7
undefined

Scope Control

范围控制

bash
undefined
bash
undefined

Search specific directory

在特定目录中搜索

ov search "API design" --uri "viking://resources/xxx"
ov search "API design" --uri "viking://resources/xxx"

Search within memories

在记忆中搜索

ov search "user habits" --uri "viking://user/memories"
undefined
ov search "user habits" --uri "viking://user/memories"
undefined

Session-Aware Search

会话感知搜索

bash
undefined
bash
undefined

Search with session context (uses conversation history for better retrieval)

结合会话上下文进行搜索(使用对话历史以获得更优检索结果)

ov search "previous decision" --session-id "session-abc123"
undefined
ov search "previous decision" --session-id "session-abc123"
undefined

Output

输出

Returns a ranked list of matching resources with relevance scores:
URI: viking://resources/docs/api.md
Score: 0.8523
Abstract: API endpoints for user authentication...

URI: viking://user/memories/preferences
Score: 0.7891
Abstract: User prefers dark mode and compact layout...
返回带有相关性得分的匹配资源排序列表:
URI: viking://resources/docs/api.md
Score: 0.8523
Abstract: API endpoints for user authentication...

URI: viking://user/memories/preferences
Score: 0.7891
Abstract: User prefers dark mode and compact layout...

Other Utilities

其他实用工具

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
ov ls viking://resources/my-project

Simple path output (for scripts)

简单路径输出(适用于脚本)

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

Recursive listing

递归列出内容

ov ls viking://resources --recursive
ov ls viking://resources --recursive

Show hidden files

显示隐藏文件

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

Control output limits

控制输出限制

ov ls viking://resources --node-limit 50 --abs-limit 128
undefined
ov ls viking://resources --node-limit 50 --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 and 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

Read File Content (
ov read
)

读取文件内容(
ov read

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

Read full content

读取完整内容

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

Read abstract (L0 - quick summary)

读取摘要(L0 - 快速概览)

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

Read overview (L1 - key points)

读取概述(L1 - 关键点)

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

Agent Best Practices

Agent最佳实践

Choosing Search Methods

选择搜索方法

  • ov search
    — Default choice. Context-aware, combines semantic + directory recursive retrieval
  • ov grep
    — Exact text pattern matching (like
    grep
    command)
  • ov glob
    — File path pattern matching (like shell glob)
  • ov search
    — 默认选择。具备上下文感知能力,结合语义检索与目录递归检索
  • ov grep
    — 精确文本模式匹配(类似
    grep
    命令)
  • ov glob
    — 文件路径模式匹配(类似shell通配符)

Query Formulation

查询表述

Write specific, contextual queries:
bash
undefined
编写具体的、带有上下文的查询:
bash
undefined

Too vague

过于模糊

ov search "API"
ov search "API"

Better

更优

ov search "REST API authentication with JWT tokens"
ov search "REST API authentication with JWT tokens"

Even better with scope

结合范围限制更佳

ov search "JWT token refresh flow" --uri "viking://resources/backend"
undefined
ov search "JWT token refresh flow" --uri "viking://resources/backend"
undefined

Combining with Other Commands

与其他命令结合使用

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/xxx"
ov search "authentication" --uri "viking://resources/xxx"

Then read specific content

然后读取特定内容

ov read viking://resources/backend/auth.md
ov read viking://resources/backend/auth.md

Or get overview for context

或获取概述以了解上下文

ov overview viking://resources/backend
undefined
ov overview viking://resources/backend
undefined

Prerequisites

前提条件

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