Skip to content

Commit 41b5c7e

Browse files
committed
docs(init): guide local harness setup
1 parent 2b257e0 commit 41b5c7e

6 files changed

Lines changed: 82 additions & 30 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,26 +66,28 @@ Install the DevSpace CLI:
6666
npm install -g @waishnav/devspace
6767
```
6868

69-
Then initialize and start the server:
69+
Then initialize DevSpace:
7070

7171
```bash
7272
devspace init
73-
devspace serve
7473
```
7574

7675
Or run it without a global install:
7776

7877
```bash
7978
npx @waishnav/devspace init
80-
npx @waishnav/devspace serve
8179
```
8280

8381
During setup, DevSpace asks for:
8482

85-
- the local project folders ChatGPT is allowed to open through DevSpace
83+
- the local project folders DevSpace is allowed to open
8684
- the local port, usually `7676`
87-
- your public HTTPS base URL from Cloudflare Tunnel, ngrok, Pinggy, Tailscale Funnel, or
88-
another reverse proxy
85+
- whether a remote MCP host and/or local coding harness will use DevSpace
86+
- which subagent providers DevSpace may launch
87+
88+
If a remote MCP host will connect, setup also asks for your public HTTPS base
89+
URL from Cloudflare Tunnel, ngrok, Pinggy, Tailscale Funnel, or another reverse
90+
proxy. Local-harness-only setups do not need a tunnel or public URL.
8991

9092
Use the public origin without `/mcp` during setup:
9193

@@ -94,6 +96,9 @@ https://your-tunnel-host.example.com
9496
```
9597

9698
You will configure your MCP client with the public `/mcp` URL after setup.
99+
Run `devspace serve` when using the MCP server. For a local coding harness,
100+
setup prints a `skills` command that installs DevSpace's Subagents skill into
101+
the harnesses you choose; DevSpace does not write into their skill directories.
97102

98103
When the client connects, DevSpace opens an Owner password approval page. Enter
99104
the Owner password printed by `devspace init`. It is also stored in:

docs/chatgpt-coding-workflow.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ DevSpace discovers standard Agent Skills from:
116116

117117
It also keeps compatibility with:
118118

119-
- the bundled `subagent-delegation` skill when `DEVSPACE_SUBAGENTS=1`, unless `~/.devspace/skills/subagent-delegation/SKILL.md` exists
119+
- the bundled `subagent-delegation` skill when Subagents are enabled, unless `~/.devspace/skills/subagent-delegation/SKILL.md` exists
120120
- `DEVSPACE_AGENT_DIR/skills`, defaulting to `~/.codex/skills`
121121
- additional paths from `DEVSPACE_SKILL_PATHS`
122122

@@ -140,13 +140,13 @@ Skill paths may be outside the workspace. DevSpace only permits reading:
140140
- advertised `SKILL.md` files
141141
- files under a skill directory after that skill's `SKILL.md` has been read
142142

143-
Set `DEVSPACE_SKILLS=0` to hide skills from workspace output. Set
144-
`DEVSPACE_SUBAGENTS=1` to expose the experimental subagent catalog and
145-
`subagent-delegation` skill. That skill teaches the minimal
146-
`devspace agents ls`, `devspace agents run`, `devspace agents continue`, and
147-
`devspace agents show`
148-
workflow. The catalog comes from `open_workspace`; `devspace agents ls` lists
149-
existing subagent sessions for that workspace.
143+
Set `DEVSPACE_SKILLS=0` to hide skills from workspace output. Enable Subagents
144+
and choose providers through `devspace init` or the persisted provider
145+
configuration. The bundled `subagent-delegation` skill teaches the minimal
146+
`devspace agents targets`, `devspace agents ls`, `devspace agents run`,
147+
`devspace agents continue`, and `devspace agents show` workflow. The catalog
148+
comes from `open_workspace`; `devspace agents ls` lists existing subagent
149+
sessions for that workspace.
150150

151151
## Tool Names
152152

docs/configuration.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ DevSpace discovers standard Agent Skills from:
136136

137137
It also keeps compatibility with:
138138

139-
- the bundled `subagent-delegation` skill when `DEVSPACE_SUBAGENTS=1`, unless `~/.devspace/skills/subagent-delegation/SKILL.md` exists
139+
- the bundled `subagent-delegation` skill when Subagents are enabled, unless `~/.devspace/skills/subagent-delegation/SKILL.md` exists
140140
- `DEVSPACE_AGENT_DIR/skills`, defaulting to `~/.codex/skills`
141141
- additional paths from `DEVSPACE_SKILL_PATHS`
142142

@@ -187,8 +187,16 @@ providers and their profiles are omitted from this model-facing catalog. `devspa
187187
lists existing subagent sessions for the current workspace, scoped by the
188188
workspace environment injected into shell commands. The `subagent-delegation`
189189
skill teaches the model to use only the minimal `devspace agents ls`,
190-
`devspace agents run`, `devspace agents continue`, and `devspace agents show`
191-
workflow.
190+
`devspace agents targets`, `devspace agents run`, `devspace agents continue`,
191+
and `devspace agents show` workflow.
192+
193+
For Codex, Claude Code, OpenCode, Pi, or another supported local harness, use
194+
the Skills CLI to install the same skill. DevSpace setup prints this command but
195+
does not run it or write into harness directories:
196+
197+
```bash
198+
npx skills add Waishnav/devspace --skill subagent-delegation --global
199+
```
192200

193201
Starter profile templates are available under `examples/agents/`. Copy or adapt
194202
them into one of the active profile directories before use.

docs/gotchas.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -216,21 +216,31 @@ DevSpace looks in standard Agent Skills locations:
216216

217217
It also checks compatibility and custom paths:
218218

219-
- the bundled `subagent-delegation` skill when `DEVSPACE_SUBAGENTS=1`, unless `~/.devspace/skills/subagent-delegation/SKILL.md` exists
219+
- the bundled `subagent-delegation` skill when Subagents are enabled, unless `~/.devspace/skills/subagent-delegation/SKILL.md` exists
220220
- `DEVSPACE_AGENT_DIR/skills`, defaulting to `~/.codex/skills`
221221
- additional paths from `DEVSPACE_SKILL_PATHS`
222222

223-
When `DEVSPACE_SUBAGENTS=1`, DevSpace loads agent profiles from
223+
When Subagents are enabled, DevSpace loads agent profiles from
224224
`~/.devspace/agents/*.md` and project `.devspace/agents/*.md`, then exposes a
225225
compact profile catalog through `open_workspace`. The bundled
226226
`subagent-delegation` skill keeps the model-facing workflow to
227-
`devspace agents ls`, `devspace agents run`, `devspace agents continue`, and
228-
`devspace agents show`.
227+
`devspace agents targets`, `devspace agents ls`, `devspace agents run`,
228+
`devspace agents continue`, and `devspace agents show`.
229229
Those commands automatically manage the internal local agent daemon; `devspace
230230
serve` is not a prerequisite.
231231
`devspace agents ls` lists existing subagent sessions, not profile
232232
definitions.
233233

234+
For a local coding harness, run the installation command printed by
235+
`devspace init`:
236+
237+
```bash
238+
npx skills add Waishnav/devspace --skill subagent-delegation --global
239+
```
240+
241+
The Skills CLI handles harness discovery and installation. DevSpace setup does
242+
not copy files into harness skill directories.
243+
234244
Packaged agent profile examples under `examples/agents/` are starter templates.
235245
Copy or adapt them into one of the active profile directories before use.
236246

docs/setup.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# Setup Guide
22

3-
This guide is for users who want ChatGPT or another MCP host to work in local
4-
projects through DevSpace.
3+
This guide covers both remote MCP hosts and local coding harnesses using
4+
DevSpace in local projects.
55

66
## Requirements
77

88
- Node `>=22.19 <27`
99
- npm
1010
- Git
1111
- Bash, including Git Bash or WSL on Windows
12-
- a public HTTPS URL that forwards to the local DevSpace server
12+
- a public HTTPS URL that forwards to the local DevSpace server, only when a
13+
remote MCP host will connect
1314

14-
DevSpace does not create the public tunnel for you. Use Cloudflare Tunnel,
15-
ngrok, Pinggy, Tailscale Funnel, or your own HTTPS reverse proxy.
15+
DevSpace does not create the public tunnel for you. Remote MCP users can use
16+
Cloudflare Tunnel, ngrok, Pinggy, Tailscale Funnel, or their own HTTPS reverse
17+
proxy.
1618

1719
## Install And Configure
1820

@@ -53,7 +55,26 @@ The local MCP URL is:
5355
http://127.0.0.1:7676/mcp
5456
```
5557

56-
### Public Base URL
58+
### Usage And Subagents
59+
60+
Setup asks independently whether a remote MCP host will connect and whether a
61+
local coding harness will use DevSpace subagents. It then detects the supported
62+
providers and asks which ones DevSpace may launch. These choices are persisted
63+
as provider objects under `subagents` in `~/.devspace/config.json`.
64+
65+
For a local harness, setup prints this command instead of modifying harness
66+
directories itself:
67+
68+
```bash
69+
npx skills add Waishnav/devspace --skill subagent-delegation --global
70+
```
71+
72+
The Skills CLI asks which installed harnesses should receive the skill. The
73+
skill uses `devspace agents targets`, `run`, `continue`, `show`, and `ls`; these
74+
commands start DevSpace's local agent daemon as needed and do not require
75+
`devspace serve`.
76+
77+
### Public Base URL For Remote MCP
5778

5879
Start your tunnel or reverse proxy before entering this value. Point the tunnel
5980
at:
@@ -74,6 +95,9 @@ Configure the MCP client with the full MCP endpoint:
7495
https://your-tunnel-host.example.com/mcp
7596
```
7697

98+
Skip remote MCP access during setup for a local-harness-only configuration; no
99+
public URL is required.
100+
77101
## Start The Server
78102

79103
Run:

skills/subagent-delegation/SKILL.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,17 @@ being used.
1717
Use only these commands for normal delegation:
1818

1919
```bash
20+
devspace agents targets
2021
devspace agents ls
2122
devspace agents run <profile-or-provider> "<prompt>"
2223
devspace agents continue <id> "<prompt>"
2324
devspace agents show <id>
2425
```
2526

27+
`targets` shows the providers and profiles usable from the current workspace.
28+
Use it when this skill is installed directly in a local coding harness. An MCP
29+
host may already have received the same compact catalog from `open_workspace`.
30+
2631
`ls` shows existing subagent sessions for the current workspace. DevSpace scopes
2732
it automatically from the shell environment injected by the workspace tool.
2833
Use the returned logical `agt_...` ID with `continue`; provider session IDs and
@@ -60,9 +65,9 @@ DevSpace agent integration.
6065
## Choosing a profile
6166

6267
Choose profiles from the compact subagent profile catalog returned by
63-
`open_workspace`. Use the profile name with `devspace agents run`. If no
64-
profile fits and delegation is still appropriate, use a built-in provider name
65-
from `open_workspace`.
68+
`open_workspace` or `devspace agents targets`. Use the profile name with
69+
`devspace agents run`. If no profile fits and delegation is still appropriate,
70+
use a provider listed by the same catalog.
6671

6772
Profiles may declare a model and optional effort level. To override the
6873
configured/default provider model or effort level for a run, pass `--model`

0 commit comments

Comments
 (0)