@ramp/router 0.2.64 → 0.2.68

package/README.md

@@ -1,43 +1,68 @@
 # @ramp/router
 
-Install the Ramp CLI and open the Router terminal workspace in one command:
+Install the Ramp CLI and open the Router workspace to connect coding agents and desktop apps, manage API keys, edit routing strategies, and choose subagent models.
 
-```sh
+## Install
+
+Run in one command without a global install:
+
+```bash
 npx @ramp/router
 ```
 
-Or install a global Router command:
+Or install the global `router` command:
 
-```sh
+```bash
 npm install -g @ramp/router
 router
 ```
 
-Requires Node.js 22+ and npm 10+. This package depends on an exact version of
-`@ramp/cli` for its shared native installer. It owns only the `router` npm
-command; `@ramp/cli` owns `ramp`, so installing both does not replace either shim.
-
-Bare `router` opens the interactive Router workspace; its Connect tab handles
-sign-in and configuration. It does not open a web dashboard. Explicit arguments
-are forwarded to the native CLI's `router` group, so `router status` and
-`router --version` continue to work. Help/version commands do not launch the UI
-or edit shell startup files.
-
-A global install opens the workspace once when it has an interactive terminal;
-otherwise it installs successfully and tells you to run `router` from one.
-Dependency installs and npx lifecycle hooks only install; running
-`npx @ramp/router` opens the workspace. `CI=1` or
-`RAMP_ROUTER_SKIP_ONBOARDING=1` suppresses install-time UI and optional wrapper
-prompts, but an explicit `router` command still opens the UI. An unsuccessful UI
-launch leaves the CLI installed for retry.
-
-The workspace needs a human interactive terminal. Without one, install-time UI
-is deferred and an explicit `router` command reports a usage error. Sign-in may
-open a browser from within the terminal workspace.
-
-Interactive npx launch offers persistent PATH setup with consent. Global
-installation uses npm's normal shims. Shared installation overrides and
-platform limitations are documented in `@ramp/cli`'s README. With
-`--ignore-scripts`, the first command installs the native CLI on demand.
-
-Source and issues: https://github.com/ramp-public/ramp-cli
+Requires Node.js 22+ and npm 10+ (Python is not required). Supported platforms: macOS (Apple Silicon & Intel), Linux (glibc x64 & arm64), and Windows (x64).
+
+## Router Workspace & Setup
+
+Open the interactive Router workspace or configure harnesses directly:
+
+```bash
+router                               # or: ramp router ui
+router ui --inline --height 18       # beneath your prompt (macOS/Linux)
+router ui --theme light              # dark, light, terminal, or auto (default)
+router configure                     # Start directly at harness setup
+router configure codex               # Configure a specific harness
+router status                        # View current Router connection and agent status
+```
+
+Interactive `router configure`, `keys`, `strategies`, `account`, and `subagents` open their workspace screens.
+
+For scripts and AI agents:
+
+```bash
+router --agent keys list
+router --agent --no-input configure codex  # key from RAMP_ROUTER_CONFIGURE_API_KEY or --setup-file
+```
+
+## Manage Router API Keys & Strategies
+
+Run `router login`, then `router keys` to select a key, inspect its usage, rename it, choose a routing strategy, or lock/unlock it:
+
+```bash
+router keys rename KEY_ID --name "Coding"
+router keys set-strategy KEY_ID --routing-profile "Cheap"
+router keys lock KEY_ID
+router keys unlock KEY_ID
+```
+
+For routing strategies, `router strategies` opens the account editor in interactive mode, or `router --agent strategies list --account` in script mode.
+
+## Codex Model Picker
+
+Codex CLI and Desktop use Router's recommended model shortlist by default:
+
+```bash
+router configure codex --codex-models compact --reuse-existing-key
+router configure codex --codex-models all --reuse-existing-key
+```
+
+## License
+
+MIT — powered by [`@ramp/cli`](https://www.npmjs.com/package/@ramp/cli). See [https://github.com/ramp-public/ramp-cli](https://github.com/ramp-public/ramp-cli) for full documentation and source.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ramp/router",
-  "version": "0.2.64",
+  "version": "0.2.68",
   "description": "Install the Ramp CLI and open the Router terminal workspace",
   "license": "MIT",
   "engines": {
@@ -19,7 +19,7 @@
     "postinstall": "node bin/postinstall.js"
   },
   "dependencies": {
-    "@ramp/cli": "0.2.64"
+    "@ramp/cli": "0.2.68"
   },
   "publishConfig": {
     "access": "public",