Documentation
Everything you need to give every git branch its own preview URL.
The fastest setup: let your AI assistant do it
Open Claude, Cursor, or Copilot inside your repo and point it at our AI Agent Spec. The page is a self-contained spec written for AI agents. They read it, inspect your code, and produce a working nexos.yaml — plus a Dockerfile.nexos if your repo doesn't have a build that works for preview environments. You commit, push, and you have a live preview URL.
The mental model
Three concepts and you have it.
Project
One GitHub repository. Configured once via nexos.yaml or the dashboard.
Environment
One branch of a project. Its own app, database, cache, storage, and preview URL.
Deployment
One git push. Builds and updates (or creates) the environment for that branch.
Browse the docs
Getting Started
Sign in, connect a GitHub repo, push a commit — your first preview URL in under five minutes.
nexos.yaml
One file at the root of your repo configures the entire preview environment. Full field reference.
AI Agent Spec
The page to hand to your AI assistant. Self-contained instructions for generating nexos.yaml + Dockerfile.nexos.
Projects
Connect a repo, configure builds, services, and lifecycle hooks.
Deployments
What happens between git push and a live URL — brand new vs incremental, preview URLs, environment actions.
Environment Variables
Encrypted secrets, auto-injected service URLs, bulk import.
Custom Domains
Route your own hostname to a project. Pin one branch to a stable URL or run every preview under your apex.
Nodes & Providers
Run your own compute node, or contribute capacity to the shared pool.
Install the Agent
Download the nexos-agent binary, verify checksums, run it under systemd.
Resource Limits
Per-project CPU / memory ceilings, build constraints, and account quotas.
API Reference
Automate Nexos programmatically. Authentication, endpoints, examples.