Use these pages when you want to run a framework app locally with Agentuity wiring, register and deploy it, attach a domain, and manage the environment values it reads at each stage.
Deploy Guides
Start with the part of the deploy path you are working on. The canonical command flow below shows how the pieces fit together.
Canonical Flow
agentuity dev # iterate locally with gateway wiring
agentuity project import --validate-only # confirm the directory looks right
agentuity project import # register the project, write agentuity.json
agentuity build # package .agentuity for deploy
agentuity deploy # encrypt, upload, provisionThese examples show agentuity ... for readability. If the CLI is project-local, run the same command through your package-manager exec wrapper, for example npx agentuity ..., bunx agentuity ..., pnpm exec agentuity ..., or yarn exec agentuity .... See Local versus global CLI for install and undo commands.
The full deploy command runs build itself and uploads the result. Run agentuity build ahead of time when you want to inspect the bundle, the detected framework, or launch.json before shipping.
Where to start
| Goal | Page |
|---|---|
Run a framework dev server with AGENTUITY_SDK_KEY and gateway base URLs already wired | Local Development |
| Register a directory as a cloud project, then ship it | Deploy Framework Apps |
| Attach your own domain, set DNS, verify TLS | Custom Domains |
Decide what goes in .env, what goes in cloud project vars, and what becomes a secret | Environment Variables |
| Operate after deploy: list, show, rollback, undeploy, delete | Operate a Deployment |
Inspect detector output, launch.json, or the bundle directory before deploy | Building Deployment Bundles |
See every flag for agentuity deploy | Deploying with the CLI |