byob-cli 0.2.10 → 0.2.11
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/.codex-plugin/plugin.json +1 -1
- package/README.md +11 -11
- package/package.json +1 -1
- package/skills/byob_cli/CODEX_CORE.md +4 -4
- package/skills/byob_cli/SKILL.md +6 -6
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "byob-cli",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.11",
|
|
4
4
|
"description": "Codex connector for BYOB projects, backed by Agent MCP with project context, deployment helpers, and coding tools.",
|
|
5
5
|
"skills": "./skills/byob_cli/",
|
|
6
6
|
"mcpServers": "./.mcp.json"
|
package/README.md
CHANGED
|
@@ -30,13 +30,13 @@ Refresh synced coding skills later without rerunning OAuth or changing MCP confi
|
|
|
30
30
|
npx -y byob-cli codex sync-skills --project-id <project_id> --token <agent_access_token>
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
For Local Codex billed project editing, the BYOB Agent MCP
|
|
33
|
+
For Local Codex billed project editing, the BYOB Agent MCP opens the project container as the active Codex workspace. It is powered by `codex ssh-proxy`:
|
|
34
34
|
|
|
35
35
|
```bash
|
|
36
|
-
npx -y byob-cli@
|
|
36
|
+
npx -y byob-cli@latest codex ssh-proxy '{"ssh_endpoint":"wss://..."}'
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
Use `byob-cli@
|
|
39
|
+
Use `byob-cli@latest` for Local Codex billed.
|
|
40
40
|
|
|
41
41
|
Or install it globally:
|
|
42
42
|
|
|
@@ -201,26 +201,26 @@ npx -y byob-cli codex sync-skills --project-id <project_id> --token <agent_acces
|
|
|
201
201
|
|
|
202
202
|
`codex sync-skills` downloads AIR coding-skill resources and rewrites their local skill names with `byob_` prefixes. It does not run OAuth, does not call `codex mcp add`, and does not change the active MCP server config.
|
|
203
203
|
|
|
204
|
-
### Local Codex Billed
|
|
204
|
+
### Local Codex Billed
|
|
205
205
|
|
|
206
|
-
When a user chooses **Local Codex billed**,
|
|
206
|
+
When a user chooses **Local Codex billed**, open the BYOB project as the active Codex workspace from the start of the edit session:
|
|
207
207
|
|
|
208
208
|
1. Call `byob_codex_status` for the selected project.
|
|
209
209
|
2. If `Local Codex billed` is available, call `byob_codex_connection_create` with `connection_type: "ssh_gateway"`.
|
|
210
|
-
3.
|
|
211
|
-
4.
|
|
212
|
-
5.
|
|
210
|
+
3. Hand the returned workspace metadata to the Codex host so `/home/workspace/app_data` becomes the active workspace.
|
|
211
|
+
4. Keep tokens, private keys, and complete proxy commands out of chat.
|
|
212
|
+
5. Use Codex's normal file, shell, and git workflow inside that active workspace.
|
|
213
213
|
|
|
214
|
-
The proxy command
|
|
214
|
+
The underlying proxy command bridges OpenSSH stdio to AIR's authenticated WebSocket endpoint:
|
|
215
215
|
|
|
216
216
|
```bash
|
|
217
217
|
BYOB_CODEX_SSH_TOKEN=<connection_token> \
|
|
218
218
|
ssh -i <temporary_key_file> \
|
|
219
|
-
-o ProxyCommand="npx -y byob-cli@
|
|
219
|
+
-o ProxyCommand="npx -y byob-cli@latest codex ssh-proxy '{\"ssh_endpoint\":\"<ssh_endpoint>\"}'" \
|
|
220
220
|
byob@byob-project
|
|
221
221
|
```
|
|
222
222
|
|
|
223
|
-
Agents should keep this user-facing: say "Local Codex billed
|
|
223
|
+
Agents and hosts should keep this user-facing: say "Local Codex billed", not internal labels such as `ssh_gateway`, unless debugging the connector itself.
|
|
224
224
|
|
|
225
225
|
## Multiple Projects
|
|
226
226
|
|
package/package.json
CHANGED
|
@@ -67,17 +67,17 @@ Do not add BYOB platform helper tools into user containers. Do not ask for BYOB
|
|
|
67
67
|
|
|
68
68
|
## Local Codex Billed Route
|
|
69
69
|
|
|
70
|
-
When the user selects **Local Codex billed**,
|
|
70
|
+
When the user selects **Local Codex billed**, open the BYOB project as the active Codex workspace before trying lower-fidelity Agent MCP workarounds. The expected path is:
|
|
71
71
|
|
|
72
72
|
1. Establish active project context.
|
|
73
73
|
2. Ensure the project is started and remote editing is available.
|
|
74
74
|
3. Call `byob_codex_status`.
|
|
75
75
|
4. Create a Local Codex billed connection with `byob_codex_connection_create`.
|
|
76
|
-
5. Use the returned
|
|
76
|
+
5. Use the returned Local Codex billed workspace details through `byob-cli@latest`'s `codex ssh-proxy`.
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
Local Codex billed should let Codex inspect and edit the remote project filesystem directly, including protected files such as `src/app.html` when the task requires reading them. Keep all returned tokens, private keys, and complete proxy commands out of chat and logs. Use user-facing language like "Local Codex billed"; avoid internal enum names unless debugging BYOB itself.
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
After the workspace is open, use Codex's normal file, shell, git, and verification workflow inside the remote project.
|
|
81
81
|
|
|
82
82
|
## Skill Routing
|
|
83
83
|
|
package/skills/byob_cli/SKILL.md
CHANGED
|
@@ -53,15 +53,15 @@ Refresh downloaded coding skills later without rerunning OAuth or changing MCP c
|
|
|
53
53
|
npx -y byob-cli codex sync-skills --project-id <project_id> --token <agent_access_token>
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
For **Local Codex billed** project editing,
|
|
56
|
+
For **Local Codex billed** project editing, open the BYOB project as the active Codex workspace immediately instead of trying to simulate shell/file access through Agent MCP tools:
|
|
57
57
|
|
|
58
58
|
1. Establish project context with `byob_current_project_context`.
|
|
59
59
|
2. Call `byob_codex_status` and confirm the Local Codex billed option is available.
|
|
60
60
|
3. Call `byob_codex_connection_create` with the Local Codex billed connection type.
|
|
61
|
-
4. Use the returned
|
|
61
|
+
4. Use the returned Local Codex billed workspace metadata through `byob-cli@latest` so Codex edits the remote project container as its active workspace.
|
|
62
62
|
5. Do not print tokens, private keys, or full proxy commands in chat.
|
|
63
63
|
|
|
64
|
-
|
|
64
|
+
After the workspace is open, use Codex's normal file, shell, git, and verification workflow inside the remote project.
|
|
65
65
|
|
|
66
66
|
Equivalent raw PRIM flow:
|
|
67
67
|
|
|
@@ -284,17 +284,17 @@ Do not assume `byob_*` tools exist inside the user container. They are platform
|
|
|
284
284
|
|
|
285
285
|
## Local Codex Billed Editing
|
|
286
286
|
|
|
287
|
-
When the user chooses Local Codex billed, the expected editing path is
|
|
287
|
+
When the user chooses Local Codex billed, the expected editing path is that the remote BYOB project container becomes the active Codex workspace. This gives Codex normal filesystem semantics for reading `src/app.html`, searching source, editing files, and running project-local shell commands through the local Codex account billing path.
|
|
288
288
|
|
|
289
289
|
Use this flow:
|
|
290
290
|
|
|
291
291
|
1. Confirm the project is started and `connectivity.can_remote_edit` is true.
|
|
292
292
|
2. Call `byob_codex_status`.
|
|
293
293
|
3. If Local Codex billed is available, call `byob_codex_connection_create` for that mode.
|
|
294
|
-
4. Use the returned
|
|
294
|
+
4. Use the returned Local Codex billed workspace details with `byob-cli@latest`'s `codex ssh-proxy`.
|
|
295
295
|
5. Keep credentials out of chat, logs, screenshots, and command transcripts.
|
|
296
296
|
|
|
297
|
-
|
|
297
|
+
After the workspace is open, use Codex's normal file, shell, git, and verification workflow inside the remote project.
|
|
298
298
|
|
|
299
299
|
## Project Scope
|
|
300
300
|
|