@ramp/router 0.0.0-stage → 0.2.67
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +8 -0
- package/README.md +67 -2
- package/bin/postinstall.js +6 -0
- package/bin/router.js +6 -0
- package/package.json +35 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
Copyright © 2026 Ramp Business Corporation
|
|
3
|
+
|
|
4
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
5
|
+
|
|
6
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
7
|
+
|
|
8
|
+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,68 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @ramp/router
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
Run in one command without a global install:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx @ramp/router
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Or install the global `router` command:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g @ramp/router
|
|
17
|
+
router
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Requires Node.js 22+ and npm 10+ (Python is not required). Supported platforms: macOS (Apple Silicon & Intel), Linux (glibc x64 & arm64), and Windows (x64).
|
|
21
|
+
|
|
22
|
+
## Router Workspace & Setup
|
|
23
|
+
|
|
24
|
+
Open the interactive Router workspace or configure harnesses directly:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
router # or: ramp router ui
|
|
28
|
+
router ui --inline --height 18 # beneath your prompt (macOS/Linux)
|
|
29
|
+
router ui --theme light # dark, light, terminal, or auto (default)
|
|
30
|
+
router configure # Start directly at harness setup
|
|
31
|
+
router configure codex # Configure a specific harness
|
|
32
|
+
router status # View current Router connection and agent status
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Interactive `router configure`, `keys`, `strategies`, `account`, and `subagents` open their workspace screens.
|
|
36
|
+
|
|
37
|
+
For scripts and AI agents:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
router --agent keys list
|
|
41
|
+
router --agent --no-input configure codex # key from RAMP_ROUTER_CONFIGURE_API_KEY or --setup-file
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Manage Router API Keys & Strategies
|
|
45
|
+
|
|
46
|
+
Run `router login`, then `router keys` to select a key, inspect its usage, rename it, choose a routing strategy, or lock/unlock it:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
router keys rename KEY_ID --name "Coding"
|
|
50
|
+
router keys set-strategy KEY_ID --routing-profile "Cheap"
|
|
51
|
+
router keys lock KEY_ID
|
|
52
|
+
router keys unlock KEY_ID
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
For routing strategies, `router strategies` opens the account editor in interactive mode, or `router --agent strategies list --account` in script mode.
|
|
56
|
+
|
|
57
|
+
## Codex Model Picker
|
|
58
|
+
|
|
59
|
+
Codex CLI and Desktop use Router's recommended model shortlist by default:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
router configure codex --codex-models compact --reuse-existing-key
|
|
63
|
+
router configure codex --codex-models all --reuse-existing-key
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## License
|
|
67
|
+
|
|
68
|
+
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/bin/router.js
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,37 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ramp/router",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.2.67",
|
|
4
|
+
"description": "Install the Ramp CLI and open the Router terminal workspace",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"engines": {
|
|
7
|
+
"node": ">=22",
|
|
8
|
+
"npm": ">=10"
|
|
9
|
+
},
|
|
10
|
+
"bin": {
|
|
11
|
+
"router": "bin/router.js"
|
|
12
|
+
},
|
|
13
|
+
"files": [
|
|
14
|
+
"bin/",
|
|
15
|
+
"README.md",
|
|
16
|
+
"LICENSE"
|
|
17
|
+
],
|
|
18
|
+
"scripts": {
|
|
19
|
+
"postinstall": "node bin/postinstall.js"
|
|
20
|
+
},
|
|
21
|
+
"dependencies": {
|
|
22
|
+
"@ramp/cli": "0.2.67"
|
|
23
|
+
},
|
|
24
|
+
"publishConfig": {
|
|
25
|
+
"access": "public",
|
|
26
|
+
"registry": "https://registry.npmjs.org/"
|
|
27
|
+
},
|
|
28
|
+
"repository": {
|
|
29
|
+
"type": "git",
|
|
30
|
+
"url": "git+https://github.com/ramp-public/ramp-cli.git",
|
|
31
|
+
"directory": "npm/router"
|
|
32
|
+
},
|
|
33
|
+
"homepage": "https://github.com/ramp-public/ramp-cli#readme",
|
|
34
|
+
"bugs": {
|
|
35
|
+
"url": "https://github.com/ramp-public/ramp-cli/issues"
|
|
36
|
+
}
|
|
37
|
+
}
|