Skip to content

setup.md

Latest commit

 

History

History
132 lines (87 loc) · 2.31 KB

setup.md

File metadata and controls

132 lines (87 loc) · 2.31 KB

Setup Guide

This guide is for users who want ChatGPT or another MCP host to work in local projects through DevSpace.

Requirements

  • Node >=20.12 <27; Node 22 LTS is recommended
  • npm
  • Git
  • Bash, including Git Bash or WSL on Windows
  • a public HTTPS URL that forwards to the local DevSpace server

DevSpace does not create the public tunnel for you. Use Cloudflare Tunnel, ngrok, Pinggy, Tailscale Funnel, or your own HTTPS reverse proxy.

Install And Configure

Run:

npx @waishnav/devspace init

The setup flow asks one question at a time.

Project Roots

Choose the folders ChatGPT is allowed to open through DevSpace. Keep this narrow.

Examples:

~/personal,~/work

/Users/alice/dev,/Users/alice/work

C:\Users\alice\dev,C:\Users\alice\work

Local Port

The default is 7676.

The local MCP URL is:

http://127.0.0.1:7676/mcp

Public Base URL

Start your tunnel or reverse proxy before entering this value. Point the tunnel at:

http://127.0.0.1:7676

Enter the public origin without /mcp:

https://your-tunnel-host.example.com

Configure the MCP client with the full MCP endpoint:

https://your-tunnel-host.example.com/mcp

Start The Server

Run:

npx @waishnav/devspace serve

If your tunnel URL changes for one run, override it without rewriting config:

DEVSPACE_PUBLIC_BASE_URL="https://new-tunnel.example.com" npx @waishnav/devspace serve

For a stable public URL, persist it:

npx @waishnav/devspace config set publicBaseUrl https://devspace.example.com
npx @waishnav/devspace serve

Approve The Client

When ChatGPT, Claude, or another MCP client connects, DevSpace shows an Owner password approval page. Enter the Owner password printed during setup.

The default config files are:

~/.devspace/config.json
~/.devspace/auth.json

Keep auth.json private.

Check Your Setup

Run:

npx @waishnav/devspace doctor

The doctor command reports the resolved config, Node version, Node ABI, platform, Git, Bash, public URL, allowed hosts, and SQLite native dependency status.

Running From A Local Checkout

If you are developing DevSpace itself instead of using the published package:

npm install --include=dev
npm run dev

The same setup rules apply.