Back to Details

offworld

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Offworld Reference Router

Offworld Reference Router

Use 
ow
to locate and read Offworld reference files for dependencies.
使用
ow
命令定位并读取用于依赖项的Offworld参考文件。

What This Does

功能介绍

  • Finds references for libraries and repos
  • Returns paths for reference files and local clones
  • Helps you read the right context fast
  • 查找库和代码库的参考内容
  • 返回参考文件和本地克隆的路径
  • 帮助你快速获取正确的上下文

When to Use

使用场景

  • You need docs or patterns for a dependency
  • You want the verified reference instead of web search
  • You are about to work inside a repo clone
  • 你需要某个依赖项的文档或模式
  • 你想要经过验证的参考内容而非网页搜索结果
  • 你即将在某个代码库克隆版本内开展工作

Installation and Setup

安装与设置

If Offworld CLI or opencode is missing, read 
references/installation.md
in this skill directory and follow it.
如果缺少Offworld CLI或opencode，请阅读本技能目录下的
references/installation.md
并按照指引操作。

Usage

使用方法

Find a reference:
bash
ow map search <term>     # search by name or keyword
ow map show <repo>       # get info for specific repo
Get paths for tools:
bash
ow map show <repo> --ref   # reference file path (use with Read)
ow map show <repo> --path  # clone directory path
Example workflow:
bash
undefined
查找参考内容：
bash
ow map search <term>     # 按名称或关键词搜索
ow map show <repo>       # 获取特定代码库的信息
获取工具路径：
bash
ow map show <repo> --ref   # 参考文件路径（搭配Read命令使用）
ow map show <repo> --path  # 克隆目录路径
示例工作流：
bash
undefined

1. Find the repo

1. 查找代码库

ow map search zod
ow map search zod

2. Get reference path

2. 获取参考文件路径

ow map show colinhacks/zod --ref
ow map show colinhacks/zod --ref

Output: /Users/.../.local/share/offworld/skill/offworld/references/colinhacks-zod.md

输出：/Users/.../.local/share/offworld/skill/offworld/references/colinhacks-zod.md

3. Read the reference with the path from step 2

3. 使用步骤2得到的路径读取参考内容

undefined
undefined

If Reference Not Found

若未找到参考内容

bash
ow pull <owner/repo>    # clone + generate reference
ow project init         # scan project deps, install references
bash
ow pull <owner/repo>    # 克隆并生成参考内容
ow project init         # 扫描项目依赖，安装参考内容

Notes

注意事项

  • Project map (
    .offworld/map.json
    ) takes precedence over global map when present
  • Reference files are markdown with API docs, patterns, best practices
  • Clone paths useful for exploring source code after reading reference
  • 当项目映射文件（
    .offworld/map.json
    ）存在时，其优先级高于全局映射文件
  • 参考文件为包含API文档、模式和最佳实践的Markdown文件
  • 克隆路径有助于你在阅读参考内容后探索源代码

Additional Resources

其他资源