Quickstart

Two parts: connect once, then deploy from your chat. The first part sets up the nyx CLI and wires your coding agent to nyxory; after that, deploying is a prompt. Five minutes end to end for a standard repo.

Stuck on any step? Ask Nova — the chat button at the bottom-right of every docs page. It answers straight from these docs and points you to the exact page. You never have to leave to find an answer.

1. Connect

One command installs the nyx CLI, signs you in, and wires every AI client it detects on your machine:

curl -fsSL https://nyxory.com/install.sh | bash

On Windows use irm https://nyxory.com/install.ps1 | iex; with Homebrew, brew install nyxory/tap/nyx && nyx setup.

Or wire one client directly. If you’d rather connect a single coding agent — or the one-command run didn’t detect yours — run its command:

Authentication is OAuth on first connect — there’s no token to paste. Full per-client detail, including Claude Desktop and custom MCP clients, is in Connect your agent.

Any other MCP client? Point it straight at the nyxory endpoint:

https://api.nyxory.com/mcp

Prereqs: a coding agent that speaks MCP (Claude Code, Cursor, Codex, VS Code, or any MCP client) and a git repo you want to deploy — any stack (Next.js, Astro, FastAPI, a Compose monorepo).

2. Open the repo in your agent

Open the repo in the same workspace as your connected client. Anything you’d ship to staging is fair game. Private GitHub repo? Your agent hands you a one-time GitHub App install link mid-deploy — see Deploy from a private repo.

3. Prompt

Say:

deploy this repo to nyxory

Your agent calls nyx_brain, gets back the cookbook recipe for your stack plus your project’s current state, and follows it — cloning the repo into your project workspace, setting secrets, building and pushing the image, deploying the manifests.

4. Watch it land

Your agent reports progress as tool calls. When the deploy resolves, it returns a URL like https://yourapp.nyxory.app — and the app shows up in the console, live and operated:

5. Verify

curl -I https://yourapp.nyxory.app

Expect a 200 OK, or just open it in your browser.

Done. From here:

• Connect another client → — Claude Desktop, Codex, or custom MCP setups
• How nyxory works → — the mental model behind those tool calls
• Deploy from a private repo → — one-time GitHub App install
• Add a custom domain → — bind your own hostname

Environments: Production is MCP at api.nyxory.com/mcp, apps at *.nyxory.app, console at console.nyxory.com. On the dev environment, use api.dev.nyxory.app/mcp, *.dev.nyxory.app, and console.dev.nyxory.app instead.