CodeNomad Server

May 26, 2026 · View on GitHub

CodeNomad Server is the high-performance engine behind the CodeNomad cockpit. It transforms your machine into a robust development host, managing the lifecycle of multiple OpenCode instances and providing the low-latency data streams that long-haul builders demand. It bridges your local filesystem with the UI, ensuring that whether you are on localhost or a remote tunnel, you have the speed, clarity, and control of a native workspace.

Features & Capabilities

🌍 Deployment Freedom

Remote Access: Host CodeNomad on a powerful workstation and access it from your lightweight laptop.
Code Anywhere: Tunnel in via VPN or SSH to code securely from coffee shops or while traveling.
Multi-Device: The responsive web client works on tablets and iPads, turning any screen into a dev terminal.
Always-On: Run as a background service so your sessions are always ready when you connect.

⚡️ Workspace Power

Multi-Instance: Juggle multiple OpenCode sessions side-by-side with per-instance tabs.
Long-Context Native: Scroll through massive transcripts without hitches.
Deep Task Awareness: Monitor background tasks and child sessions without losing your flow.
Command Palette: A single, global palette to jump tabs, launch tools, and fire shortcuts.

Prerequisites

OpenCode: opencode must be installed and configured on your system.
Node.js 18+ and npm (for running or building from source).
A workspace folder on disk you want to serve.
Optional: a Chromium-based browser if you want --launch to open the UI automatically.

Usage

Run via npx (Recommended)

You can run CodeNomad directly without installing it:

npx @neuralnomads/codenomad --password <your-password> --launch

Authentication required: The server requires a password. Pass it via --password, the CODENOMAD_SERVER_PASSWORD environment variable, or create an auth.json file (see Authentication below).

To list all CLI options:

npx @neuralnomads/codenomad --help

On startup, CodeNomad prints two URLs:

Local Connection URL : ... (used by desktop shells)
Remote Connection URL : ... (used by browsers/other machines when remote access is enabled)

Install Globally

Or install it globally to use the codenomad command:

npm install -g @neuralnomads/codenomad
codenomad --password <your-password> --launch

Install Locally (per-project)

If you prefer to install CodeNomad into a project and run the local binary:

npm install @neuralnomads/codenomad
npx codenomad --password <your-password> --launch

(npx codenomad ... will use ./node_modules/.bin/codenomad when present.)

Common Flags

You can configure the server using flags or environment variables:

Flag	Env Variable	Description
`--https <enabled>`	`CLI_HTTPS`	Enable HTTPS listener (default `true`)
`--http <enabled>`	`CLI_HTTP`	Enable HTTP listener (default `false`)
`--https-port <number>`	`CLI_HTTPS_PORT`	HTTPS port (default `9898`, use `0` for auto)
`--http-port <number>`	`CLI_HTTP_PORT`	HTTP port (default `9899`, use `0` for auto)
`--tls-key <path>`	`CLI_TLS_KEY`	TLS private key (PEM). Requires `--tls-cert`.
`--tls-cert <path>`	`CLI_TLS_CERT`	TLS certificate (PEM). Requires `--tls-key`.
`--tls-ca <path>`	`CLI_TLS_CA`	Optional CA chain/bundle (PEM)
`--tlsSANs <list>`	`CLI_TLS_SANS`	Additional TLS SANs (comma-separated)
`--host <addr>`	`CLI_HOST`	Interface to bind (default 127.0.0.1)
`--workspace-root <path>`	`CLI_WORKSPACE_ROOT`	Restricts the root path where new workspaces can be opened. Git worktrees are created in `.codenomad/worktrees` inside the project folder.
`--unrestricted-root`	`CLI_UNRESTRICTED_ROOT`	Allow full-filesystem browsing
`--config <path>`	`CLI_CONFIG`	Config file location
`--launch`	`CLI_LAUNCH`	Open the UI in a Chromium-based browser
`--log-level <level>`	`CLI_LOG_LEVEL`	Logging level (trace, debug, info, warn, error)
`--log-destination <path>`	`CLI_LOG_DESTINATION`	Log destination file (defaults to stdout)
`--username <username>`	`CODENOMAD_SERVER_USERNAME`	Username for CodeNomad's internal auth (default `codenomad`)
`--password <password>`	`CODENOMAD_SERVER_PASSWORD`	Password for CodeNomad's internal auth
`--generate-token`	`CODENOMAD_GENERATE_TOKEN`	Emit a one-time local bootstrap token for desktop flows
`--dangerously-skip-auth`	`CODENOMAD_SKIP_AUTH`	Disable CodeNomad's internal auth (use only behind a trusted perimeter)
`--ui-dir <path>`	`CLI_UI_DIR`	Directory containing the built UI bundle
`--ui-dev-server <url>`	`CLI_UI_DEV_SERVER`	Proxy UI requests to a running dev server (requires `--https=false --http=true`)
`--ui-no-update`	`CLI_UI_NO_UPDATE`	Disable remote UI updates
`--ui-auto-update <enabled>`	`CLI_UI_AUTO_UPDATE`	Enable remote UI updates (`true`
`--ui-manifest-url <url>`	`CLI_UI_MANIFEST_URL`	Remote UI manifest URL

Dev Releases (Advanced)

If you want the latest bleeding-edge builds (published as GitHub pre-releases), use the dev package:

npx @neuralnomads/codenomad-dev --password <your-password> --launch

These environment variables control how CodeNomad checks for dev updates:

Env Variable	Description
`CODENOMAD_UPDATE_CHANNEL`	Update channel (use `dev` to enable dev build update checks)
`CODENOMAD_GITHUB_REPO`	GitHub repo used for dev release checks (default `NeuralNomadsAI/CodeNomad`)

HTTP vs HTTPS

Default: --https=true --http=false (HTTPS only).
To run plain HTTP only (useful for development):

codenomad --https=false --http=true

To run both HTTPS (for remote) and HTTP loopback (for desktop):

codenomad --https=true --http=true

Remote Access Binding Rules

When remote access is enabled (bind host is non-loopback, e.g. --host 0.0.0.0):
- HTTP listens on 127.0.0.1 only.
- HTTPS listens on --host (LAN/all interfaces).
When remote access is disabled (bind host is loopback, e.g. --host 127.0.0.1):
- Both HTTP and HTTPS listen on 127.0.0.1.

Self-Signed Certificates

If --https=true and you do not provide --tls-key/--tls-cert, CodeNomad generates a local certificate automatically under your config directory:

~/.config/codenomad/tls/ca-cert.pem
~/.config/codenomad/tls/server-cert.pem

Certificates are valid for about 30 days and rotate automatically on startup when needed. You can add extra SANs via:

codenomad --tlsSANs "localhost,127.0.0.1,my-hostname,192.168.1.10"

Browser warning: Self-signed certificates trigger a "Your connection is not private" warning in browsers on first visit. This is expected and safe for local development (127.0.0.1 / localhost):

Chrome/Brave/Edge: Click Advanced → Proceed to 127.0.0.1 (unsafe)

Firefox: Click Advanced → Accept the Risk and Continue

Alternative: For local-only development without the warning, run with --https=false --http=true

Note: Only accept self-signed certificates for localhost/127.0.0.1 that you control. For remote hosts, use proper TLS certificates.

Authentication

Default behavior: CodeNomad requires a login (username/password) and stores a session cookie in the browser.
--dangerously-skip-auth / CODENOMAD_SKIP_AUTH=true disables the login prompt and treats all requests as authenticated. Use this only when access is already protected by another layer (SSO proxy, VPN, Coder workspace auth, etc.). If you bind to 0.0.0.0 while skipping auth, anyone who can reach the port can access the API.

Setting a password

Practical setup options:

Runtime password (every start): Use --password <your-password> or set CODENOMAD_SERVER_PASSWORD=<your-password> environment variable
Persistent password (UI setup): Launch with --generate-token, complete the local bootstrap flow in your browser, then set a password through the UI settings

The --password flag and CODENOMAD_SERVER_PASSWORD env var are runtime credentials — they must be provided on every server start and are not persisted to disk.

Advanced: auth.json internals

The auth.json file (~/.config/codenomad/auth.json) is automatically created and managed by CodeNomad when you set a password through the UI. You generally don't need to edit this file manually. For reference, it uses the following scrypt-based schema:

{
  "version": 1,
  "username": "codenomad",
  "password": {
    "algorithm": "scrypt",
    "saltBase64": "<base64-salt>",
    "hashBase64": "<base64-hash>",
    "keyLength": 64,
    "params": {
      "N": 16384,
      "r": 8,
      "p": 1,
      "maxmem": 33554432
    }
  },
  "userProvided": true,
  "updatedAt": "2026-05-18T12:00:00.000Z"
}

Manual creation of this file is not recommended unless you have a helper to generate a valid scrypt PasswordHashRecord.

Progressive Web App (PWA)

When running as a server CodeNomad can also be installed as a PWA from any supported browser, giving you a native app experience just like the Electron installation but executing on the remote server instead.

Open the CodeNomad UI in a Chromium-based browser (Chrome, Edge, Brave, etc.).
Click the install icon in the address bar, or use the browser menu → "Install CodeNomad".
The app will open in a standalone window and appear in your OS app list.

TLS requirement Browsers require a secure (https://) connection for PWA installation. If you host CodeNomad on a remote machine, use HTTPS. Self-signed certificates generally won't work unless they are explicitly trusted by the device/browser (e.g., via a custom CA).

Data Storage

Config: ~/.config/codenomad/config.json
Instance Data: ~/.config/codenomad/instances (chat history, etc.)