Skip to content

oscabriel/offworld

Repository files navigation

Offworld

One skill for your whole stack.

CLI tool that gives your coding agents instant, up-to-date context on any open source repo.

The Problem

Your agent is good at searching the web and using the pre-written skills you've downloaded, but every time it needs to understand a new thing, it has to go through the same motions again. It figures it out eventually, but the path is expensive and fragile.

  • Token burn to rediscover docs and source
  • Hallucination from deep context
  • No memory between sessions

The Solution

ow project init

Offworld is a single skill file and a robust CLI tool dedicated to empowering your agent with instant context on any open source repo. The skill directory keeps a persistent git clone map and reference files for each dependency in your stack. And one CLI command scans your deps, creates git clones, and generates reference files for each dependency (or pulls them from our web directory), to be used by the skill to quickly understand and navigate at the source.

What Makes Offworld Different

  • On-demand generation — References created from the latest commit. Keep them updated by running the command again.
  • Scan your whole stack — One command resolves your manifest and installs references for every dependency.
  • One skill everywhere — A single routing skill is symlinked to all your agents.
  • Focused context — The ow CLI tool ensures agents only read files relevant to your current question.

Installation

# curl (recommended)
curl -fsSL https://offworld.sh/install | bash

# npm
npm install -g offworld

# bun
bun add -g offworld

# Homebrew
brew install oscabriel/tap/offworld

# skills.sh
npx skills add oscabriel/offworld-skill --skill offworld

Install via skills.sh

You can also install the Offworld skill directly with the skills npm package:

npx skills add oscabriel/offworld-skill --skill offworld

After installing the skill, use your agent to run the setup flow in references/installation.md.

For LLM Agents

Instructions for LLM Agents (click to expand)

If you're an LLM agent helping set up Offworld, follow these steps:

Step 0: Ask for preferences (agent-guided)

Ask the user for:

  • Install method (install script vs package manager)
  • Agents to sync (e.g. opencode, claude, codex)
  • Clone directory (default ~/ow)
  • Model preference (provider/model) or use defaults
  • Dependency selection (all vs a curated list)

Use their answers to fill flags in the commands below. Avoid running interactive CLI flows.

Step 1: Install the CLI

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

Or use your preferred package manager:

npm install -g offworld

Step 2: Initialize Offworld (non-interactive)

ow init --yes --agents "<agent-list>" --repo-root "<clone-dir>" --model "<provider/model>"

This will:

  • Create config at ~/.config/offworld/config.json
  • Set the clone directory (~/ow/)
  • Configure which agents to sync reference files to
  • Set the default model for reference generation

Step 3: Verify the installation

ow --version
ow config show

Step 4: Initialize in the current project (non-interactive)

ow project init --yes --all

This will:

  • Scan package.json (or other manifest files) for dependencies
  • Install reference files for selected dependencies
  • Generate missing references when needed
  • Update AGENTS.md with a table of installed reference files

If you want a specific set of dependencies instead of --all:

ow project init --yes --deps "zod,typescript,vitest"

Or exclude specific dependencies:

ow project init --yes --all --skip "react,react-dom"

Step 5: Verify setup

List the installed reference files:

ow list

Troubleshooting

If reference files are not appearing, check:

  1. Is the config valid? ow config show
  2. Where is the config file? ow config path
  3. Check the reference directory: ls ~/.local/share/offworld/skill/offworld/references/

Quick Start

# One-time setup
ow init

# Install references for your project's dependencies
cd your-project
ow project init

How It Works

  1. One Skill for All Agents — Install a single SKILL.md file that is symlinked to all your coding agents automatically.

  2. Clone the Repo — CLI creates managed git clones on your machine that you and your agents can read at any time.

  3. Generate Reference from Source — Agent explores the cloned repo and creates a reference file with common patterns, API details, and best practices.

  4. Query Your Clones — Ask your agent about one of your clones and watch it read the reference, search the code, and answer questions fast.

CLI Commands

Command Description
ow project init Scan deps, generate references, update map
ow pull <repo> Clone + fetch/generate reference (or clone only)
ow list List managed repos
ow generate <repo> Force local AI generation
ow push <repo> Share reference to offworld.sh
ow rm <repo> Remove repo and reference files
ow init Interactive global setup
ow config show View configuration
ow repo update --all Pull latest for all cloned repos
ow repo status Summary: total repos, disk usage, stale count

Local Layout

/skill/offworld/
├── SKILL.md           # Static routing skill
├── assets/
│   └── map.json       # Canonical clone map
└── references/
    ├── tanstack-router.md
    └── ...

The clone map gives agents a stable pointer to the right source tree without rediscovering it every session.

Supported Agents

The single skill is symlinked to all detected agents:

  • OpenCode (~/.config/opencode/skill/)
  • Claude Code (~/.claude/skills/)
  • Codex (~/.codex/skills/)
  • Amp (~/.config/agents/skills/)
  • Antigravity (~/.gemini/antigravity/skills/)
  • Cursor (~/.cursor/skills/)
  • More soon!

Web App

Browse and search community references at offworld.sh. Download pre-generated references or share your own.

Project Structure

offworld/
├── apps/
│   ├── cli/         # CLI (offworld / ow)
│   ├── web/         # Web app (offworld.sh)
│   ├── docs/        # Documentation (Astro Starlight)
│   └── tui/         # Terminal UI (OpenTUI)
├── packages/
│   ├── sdk/         # Core logic
│   ├── types/       # Zod schemas + TypeScript types
│   ├── backend/     # Convex serverless functions
│   └── config/      # Shared tsconfig

Development

bun install              # Install deps
bun run dev              # Start all apps
bun run build:cli        # Build CLI + link globally
bun run check            # Oxlint + Oxfmt
bun run typecheck        # TypeScript
bun run test             # Vitest

Links

License

MIT

About

One skill for your whole stack, and a CLI tool to guide the way.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors