Skip to content

Commit 0ab0daa

Browse files
committed
docs: add remote coding tool quickstart
1 parent daf2a73 commit 0ab0daa

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

docs/quickstart.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,32 @@ ssh okdev-<session>
7878
ssh -tt okdev-<session>
7979
```
8080

81+
## Remote Coding Tools
82+
83+
`okdev` does not have first-class coding-agent commands yet, but the SSH workflow already works with remote development tools that can connect over SSH.
84+
85+
Examples:
86+
87+
```bash
88+
# Open a plain remote shell and install tools in the container
89+
ssh okdev-<session>
90+
91+
# Then inside the container, install or run the tools you want
92+
codex
93+
claude
94+
```
95+
96+
Cursor and similar editors can use the managed `okdev-<session>` SSH host directly for remote development. The generated SSH host entry bypasses tmux by default, which is usually the right behavior for editor-driven SSH sessions.
97+
98+
Typical flow:
99+
100+
1. `okdev up`
101+
2. Open your editor's SSH remote connection to `okdev-<session>`
102+
3. Install `codex`, `claude`, or other CLI tools inside the container if needed
103+
4. Use the editor remote session or `ssh okdev-<session>` as your entry point
104+
105+
Use `okdev ssh` when you want the tmux-backed interactive shell managed by okdev. Use `ssh okdev-<session>` when you want a plain SSH session for editors, remote IDEs, or direct tool execution.
106+
81107
## File Sync
82108

83109
`okdev up` starts bidirectional Syncthing sync automatically. For manual control:

0 commit comments

Comments
 (0)