Skip to content

setup.md

Latest commit

 

History

History
145 lines (97 loc) · 2.6 KB

setup.md

File metadata and controls

145 lines (97 loc) · 2.6 KB
Raw

Setup Guide

This guide is for users who want ChatGPT to work in local projects through DevSpace. Other MCP hosts are not supported.

Requirements

  • Node >=22.19 <27
  • npm
  • Git
  • Bash, including Git Bash or WSL on Windows
  • a public HTTPS URL that forwards to the local DevSpace server
  • a tunnel client such as cloudflared

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

Install This Fork

git clone https://github.com/keepkeen/devspace.git
cd devspace
npm ci
npm run build

All commands below run from this checkout. You may use devspace instead of node dist/cli.js after running npm link.

Configure

Run:

node dist/cli.js 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 ChatGPT Connector with the full MCP endpoint:

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

Start The Server

Run:

node dist/cli.js serve

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

DEVSPACE_PUBLIC_BASE_URL="https://new-tunnel.example.com" node dist/cli.js serve

For a stable public URL, persist it:

node dist/cli.js config set publicBaseUrl https://devspace.example.com
node dist/cli.js serve

Approve The Client

When ChatGPT 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:

node dist/cli.js 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.