offworld 0.1.0 → 0.1.1

package/README.md

@@ -1,22 +1,32 @@
 # Offworld CLI
 
-One skill for your whole stack.
+**One skill for your whole stack.**
+
+A single skill file and a CLI tool dedicated to empowering your agent with instant context on any open source repo.
 
 ## Installation
 
 ```bash
-bun add -g offworld
-# or
+# 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
 ```
 
 ## Quick Start
 
 ```bash
-# Initialize config
+# One-time setup
 ow init
 
-# Install references for project deps
+# Install references for your project's dependencies
 cd your-project
 ow project init
 
@@ -31,57 +41,48 @@ ow list
 
 ### Core
 
-| Command              | Description                       |
-| -------------------- | --------------------------------- |
-| `ow pull <repo>`     | Clone repo and generate reference |
-| `ow generate <repo>` | Generate reference locally        |
-| `ow push <repo>`     | Upload reference to offworld.sh   |
-| `ow list`            | List managed repos                |
-| `ow remove <repo>`   | Remove repo and/or reference      |
+| Command | Description |
+| --- | --- |
+| `ow pull <repo>` | Clone repo and generate reference |
+| `ow generate <repo>` | Generate reference locally |
+| `ow push <repo>` | Upload reference to offworld.sh |
+| `ow list` | List managed repos |
+| `ow rm <repo>` | Remove repo and/or reference |
 
 ### Configuration
 
-| Command                       | Description                 |
-| ----------------------------- | --------------------------- |
-| `ow init`                     | Interactive setup           |
-| `ow config show`              | Show all settings           |
-| `ow config set <key> <value>` | Set a config value          |
-| `ow config get <key>`         | Get a config value          |
-| `ow config agents`            | Select agents interactively |
+| Command | Description |
+| --- | --- |
+| `ow init` | Interactive setup |
+| `ow config show` | Show all settings |
+| `ow config set <key> <value>` | Set a config value |
+| `ow config get <key>` | Get a config value |
+| `ow config agents` | Select agents interactively |
 
-### Map / Routing
+### Project
 
-| Command                     | Description                     |
-| --------------------------- | ------------------------------- |
-| `ow map show <repo>`        | Show repo info (path, ref, etc) |
-| `ow map show <repo> --ref`  | Print only reference file path  |
-| `ow map show <repo> --path` | Print only local clone path     |
-| `ow map search <term>`      | Find repos by name or keyword   |
+| Command | Description |
+| --- | --- |
+| `ow project init` | Scan deps, install references |
 
 ### Repository Management
 
-| Command                | Description               |
-| ---------------------- | ------------------------- |
-| `ow repo list`         | List managed repos        |
-| `ow repo update --all` | Update all repos          |
-| `ow repo prune`        | Remove stale map entries  |
-| `ow repo status`       | Show repo summary         |
-| `ow repo gc`           | Garbage collect old repos |
-| `ow repo discover`     | Index existing repos      |
-
-### Project
-
-| Command           | Description                   |
-| ----------------- | ----------------------------- |
-| `ow project init` | Scan deps, install references |
+| Command | Description |
+| --- | --- |
+| `ow repo list` | List managed repos |
+| `ow repo update --all` | Update all repos |
+| `ow repo status` | Show repo summary |
+| `ow repo prune` | Remove stale map entries |
+| `ow repo gc` | Garbage collect old repos |
+| `ow repo discover` | Index existing repos |
 
 ### Authentication
 
-| Command          | Description          |
-| ---------------- | -------------------- |
-| `ow auth login`  | Login to offworld.sh |
-| `ow auth logout` | Logout               |
-| `ow auth status` | Show auth status     |
+| Command | Description |
+| --- | --- |
+| `ow auth login` | Login to offworld.sh |
+| `ow auth logout` | Logout |
+| `ow auth status` | Show auth status |
 
 ## Options
 
@@ -105,7 +106,7 @@ ow list
 --pattern <pat>   Filter by pattern
 ```
 
-### `ow remove`
+### `ow rm`
 
 ```
 --yes, -y           Skip confirmation
@@ -125,29 +126,14 @@ ow list
 --yes, -y         Skip confirmations
 ```
 
-### `ow map show`
-
-```
---json            Output as JSON
---path            Print only local clone path
---ref             Print only reference file path
-```
-
-### `ow map search`
-
-```
---limit, -n       Max results (default 10)
---json            Output as JSON
-```
-
 ## Config Keys
 
-| Key              | Type    | Description                                           |
-| ---------------- | ------- | ----------------------------------------------------- |
-| `repoRoot`       | string  | Where to clone repos (default: `~/ow`)                |
-| `defaultShallow` | boolean | Use shallow clone by default                          |
-| `defaultModel`   | string  | AI model (e.g., `anthropic/claude-sonnet-4-20250514`) |
-| `agents`         | list    | Comma-separated agent names                           |
+| Key | Type | Description |
+| --- | --- | --- |
+| `repoRoot` | string | Where to clone repos (default: `~/ow`) |
+| `defaultShallow` | boolean | Use shallow clone by default |
+| `defaultModel` | string | AI model (e.g., `anthropic/claude-sonnet-4-20250514`) |
+| `agents` | list | Comma-separated agent names |
 
 ## Path Discovery
 
@@ -155,12 +141,12 @@ ow list
 
 ```json
 {
-	"paths": {
-		"skillDir": "~/.local/share/offworld/skill/offworld",
-		"globalMap": "~/.local/share/offworld/skill/offworld/assets/map.json",
-		"referencesDir": "~/.local/share/offworld/skill/offworld/references",
-		"projectMap": "/abs/path/to/repo/.offworld/map.json"
-	}
+  "paths": {
+    "skillDir": "~/.local/share/offworld/skill/offworld",
+    "globalMap": "~/.local/share/offworld/skill/offworld/assets/map.json",
+    "referencesDir": "~/.local/share/offworld/skill/offworld/references",
+    "projectMap": "/abs/path/to/repo/.offworld/map.json"
+  }
 }
 ```
 
@@ -168,19 +154,19 @@ ow list
 
 Single skill symlinked to:
 
-- **OpenCode**: `~/.config/opencode/skill/`
-- **Claude Code**: `~/.claude/skills/`
-- **Codex**: `~/.codex/skills/`
-- **Amp**: `~/.config/agents/skills/`
-- **Antigravity**: `~/.gemini/antigravity/skills/`
-- **Cursor**: `~/.cursor/skills/`
+- OpenCode (`~/.config/opencode/skill/`)
+- Claude Code (`~/.claude/skills/`)
+- Codex (`~/.codex/skills/`)
+- Amp (`~/.config/agents/skills/`)
+- Antigravity (`~/.gemini/antigravity/skills/`)
+- Cursor (`~/.cursor/skills/`)
 
 ## Environment Variables
 
-| Variable            | Description                             |
-| ------------------- | --------------------------------------- |
+| Variable | Description |
+| --- | --- |
 | `ANTHROPIC_API_KEY` | Required for local reference generation |
-| `WORKOS_CLIENT_ID`  | Required for `ow auth login`            |
+| `WORKOS_CLIENT_ID` | Required for `ow auth login` |
 
 ## License
 

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { r as version, t as createOwCli } from "./src-CZHUGu1Q.mjs";
+import { r as version, t as createOwCli } from "./src-BIbq5vJB.mjs";
 import { existsSync, readFileSync } from "node:fs";
 import { dirname, resolve } from "node:path";
 import { fileURLToPath } from "node:url";

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import { z } from "zod";
 import * as trpc_cli_dist_json_js0 from "trpc-cli/dist/json.js";
 
 //#region src/index.d.ts
-declare const version = "0.1.0";
+declare const version = "0.1.1";
 declare const router: {
   pull: _orpc_server0.Procedure<_orpc_server0.MergedInitialContext<Record<never, never>, Record<never, never>, Record<never, never>>, Record<never, never>, z.ZodObject<{
     repo: z.ZodString;

package/dist/index.mjs

@@ -1,3 +1,3 @@
-import { n as router, r as version, t as createOwCli } from "./src-CZHUGu1Q.mjs";
+import { n as router, r as version, t as createOwCli } from "./src-BIbq5vJB.mjs";
 
 export { createOwCli, router, version };

package/dist/{src-CZHUGu1Q.mjs → src-BIbq5vJB.mjs}

@@ -5,6 +5,7 @@ import { createCli } from "trpc-cli";
 import { z } from "zod";
 import * as p from "@clack/prompts";
 import { AuthenticationError, CommitExistsError, CommitNotFoundError, GitHubError, InvalidInputError, InvalidReferenceError, LowStarsError, NotLoggedInError, Paths, PrivateRepoError, RateLimitError, RepoExistsError, SyncRepoNotFoundError, TokenExpiredError, checkRemote, checkRemoteByName, cleanShellConfig, clearAuthData, cloneRepo, detectInstallMethod, detectInstalledAgents, discoverRepos, executeUninstall, executeUpgrade, fetchLatestVersion, gcRepos, generateReferenceWithAI, getAllAgentConfigs, getAuthPath, getAuthStatus, getClonedRepoPath, getCommitDistance, getCommitSha, getConfigPath, getCurrentVersion, getMapEntry, getMetaPath, getMetaRoot, getProvider, getReferencePath, getRepoRoot, getRepoStatus, getShellConfigFiles, getToken, installGlobalSkill, installReference, isRepoCloned, listProviders, listRepos, loadAuthData, loadConfig, matchDependenciesToReferences, parseDependencies, parseRepoInput, pruneRepos, pullReference, pullReferenceByName, pushReference, readGlobalMap, removeRepo, resolveDependencyRepo, saveAuthData, saveConfig, searchMap, toReferenceFileName, toReferenceName, updateAgentFiles, updateAllRepos, updateRepo, validateProviderModel, writeProjectMap } from "@offworld/sdk";
+import { ReferenceMetaSchema, WorkOSAuthErrorResponseSchema, WorkOSDeviceAuthResponseSchema, WorkOSTokenResponseSchema } from "@offworld/types";
 import { AgentSchema, ConfigSchema } from "@offworld/types/schemas";
 import open from "open";
 import { homedir } from "node:os";
@@ -47,7 +48,10 @@ function loadLocalMeta(source) {
 	const metaPath = join(getLocalMetaDir(source), "meta.json");
 	if (!existsSync(metaPath)) return null;
 	try {
-		return JSON.parse(readFileSync(metaPath, "utf-8"));
+		const json = JSON.parse(readFileSync(metaPath, "utf-8"));
+		const parsed = ReferenceMetaSchema.safeParse(json);
+		if (!parsed.success) return null;
+		return parsed.data;
 	} catch {
 		return null;
 	}
@@ -714,7 +718,10 @@ function loadLocalReference(metaDir, referencePath, fullName) {
 	if (!existsSync(referencePath) || !existsSync(metaPath)) return null;
 	try {
 		const referenceContent = readFileSync(referencePath, "utf-8");
-		const meta = JSON.parse(readFileSync(metaPath, "utf-8"));
+		const json = JSON.parse(readFileSync(metaPath, "utf-8"));
+		const parsed = ReferenceMetaSchema.safeParse(json);
+		if (!parsed.success) return null;
+		const meta = parsed.data;
 		return {
 			fullName: "",
 			referenceName: toReferenceName(fullName),
@@ -1140,17 +1147,17 @@ async function configSetHandler(options) {
 	}
 	else if (key === "agents") {
 		const agentValues = value.split(",").map((a) => a.trim()).filter(Boolean);
-		const validAgents = AgentSchema.options;
-		const invalidAgents = agentValues.filter((a) => !validAgents.includes(a));
-		if (invalidAgents.length > 0) {
+		const agentsResult = z.array(AgentSchema).safeParse(agentValues);
+		if (!agentsResult.success) {
+			const invalidAgents = agentValues.filter((a) => !AgentSchema.options.includes(a));
 			p.log.error(`Invalid agent(s): ${invalidAgents.join(", ")}`);
-			p.log.info(`Valid agents: ${validAgents.join(", ")}`);
+			p.log.info(`Valid agents: ${AgentSchema.options.join(", ")}`);
 			return {
 				success: false,
 				message: `Invalid agents: ${invalidAgents.join(", ")}`
 			};
 		}
-		parsedValue = agentValues;
+		parsedValue = agentsResult.data;
 	} else parsedValue = value;
 	try {
 		saveConfig({ [key]: parsedValue });
@@ -1229,7 +1236,8 @@ async function configAgentsHandler() {
 		p.log.warn("Cancelled");
 		return { success: false };
 	}
-	const agents = agentsResult;
+	const parsedAgents = z.array(AgentSchema).safeParse(agentsResult);
+	const agents = parsedAgents.success ? parsedAgents.data : [];
 	try {
 		saveConfig({ agents });
 		p.log.success(`Agents set to: ${agents.join(", ") || "(none)"}`);
@@ -1277,7 +1285,8 @@ async function requestDeviceCode() {
 		const error = await response.text();
 		throw new Error(`Failed to request device code: ${error}`);
 	}
-	return response.json();
+	const data = await response.json();
+	return WorkOSDeviceAuthResponseSchema.parse(data);
 }
 async function pollForTokens(deviceCode, interval, onStatus) {
 	let pollInterval = interval;
@@ -1291,8 +1300,12 @@ async function pollForTokens(deviceCode, interval, onStatus) {
 				client_id: getWorkosClientId()
 			})
 		});
-		if (response.ok) return response.json();
-		const data = await response.json();
+		if (response.ok) {
+			const data = await response.json();
+			return WorkOSTokenResponseSchema.parse(data);
+		}
+		const errorData = await response.json();
+		const data = WorkOSAuthErrorResponseSchema.parse(errorData);
 		switch (data.error) {
 			case "authorization_pending":
 				onStatus?.("Waiting for approval...");
@@ -1576,7 +1589,7 @@ async function initHandler(options = {}) {
 				configPath
 			};
 		}
-		provider = providerResult;
+		provider = String(providerResult);
 		spin.start("Fetching models...");
 		const providerData = await getProvider(provider);
 		spin.stop(`Loaded ${providerData?.models.length ?? 0} models`);
@@ -1607,7 +1620,7 @@ async function initHandler(options = {}) {
 				configPath
 			};
 		}
-		model = modelResult;
+		model = String(modelResult);
 	}
 	const detectedAgents = detectInstalledAgents();
 	const allAgentConfigs = getAllAgentConfigs();
@@ -1624,7 +1637,8 @@ async function initHandler(options = {}) {
 	if (options.agents) {
 		const agentNames = options.agents.split(",").map((a) => a.trim());
 		const validAgents = allAgentConfigs.filter((c) => agentNames.includes(c.name)).map((c) => c.name);
-		if (validAgents.length === 0) {
+		const agentsResult = z.array(AgentSchema).safeParse(validAgents);
+		if (!agentsResult.success || agentsResult.data.length === 0) {
 			p.log.error("No valid agent names provided");
 			p.outro("Setup failed");
 			return {
@@ -1632,23 +1646,24 @@ async function initHandler(options = {}) {
 				configPath
 			};
 		}
-		agents = validAgents;
+		agents = agentsResult.data;
 	} else {
 		const initialAgents = existingConfig.agents && existingConfig.agents.length > 0 ? existingConfig.agents : detectedAgents;
-		const agentsResult = await p.multiselect({
+		const selectResult = await p.multiselect({
 			message: "Select agents to install skills to",
 			options: agentOptions,
 			initialValues: initialAgents,
 			required: false
 		});
-		if (p.isCancel(agentsResult)) {
+		if (p.isCancel(selectResult)) {
 			p.outro("Setup cancelled");
 			return {
 				success: false,
 				configPath
 			};
 		}
-		agents = agentsResult;
+		const agentsResult = z.array(AgentSchema).safeParse(selectResult);
+		agents = agentsResult.success ? agentsResult.data : [];
 	}
 	const defaultModel = `${provider}/${model}`;
 	const newConfig = {
@@ -1790,7 +1805,7 @@ async function projectInitHandler(options = {}) {
 				message: "Cancelled by user"
 			};
 		}
-		selected = selectedResult;
+		selected = Array.isArray(selectedResult) ? selectedResult : [];
 	}
 	if (selected.length === 0) {
 		p.log.warn("No dependencies selected.");
@@ -2144,7 +2159,7 @@ async function mapSearchHandler(options) {
 
 //#endregion
 //#region src/index.ts
-const version = "0.1.0";
+const version = "0.1.1";
 const router = os.router({
 	pull: os.input(z.object({
 		repo: z.string().describe("repo").meta({ positional: true }),
@@ -2444,4 +2459,4 @@ function createOwCli() {
 
 //#endregion
 export { router as n, version as r, createOwCli as t };
-//# sourceMappingURL=src-CZHUGu1Q.mjs.map
+//# sourceMappingURL=src-BIbq5vJB.mjs.map