Offworld Reference Router

Use ow to locate and read Offworld reference files for dependencies.

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

Prerequisites

Check that the CLI is available:

ow --version

If ow is not available, install it:

curl -fsSL https://offworld.sh/install | bash

Setup

Initialize Offworld once per machine:

ow init

For a specific project, build a project map:

ow project init

Usage

Find a reference:

ow map search <term>     # search by name or keyword
ow map show <repo>       # get info for specific repo

Get paths for tools:

ow map show <repo> --ref   # reference file path (use with Read)
ow map show <repo> --path  # clone directory path

Example workflow:

# 1. Find the repo
ow map search zod

# 2. Get reference path
ow map show colinhacks/zod --ref
# Output: /Users/.../.local/share/offworld/skill/offworld/references/colinhacks-zod.md

# 3. Read the reference with the path from step 2

If Reference Not Found

ow pull <owner/repo>    # clone + generate reference
ow project init         # scan project deps, install references

All Commands

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

Additional Resources

• •Docs: https://offworld.sh/cli