Agent index (llms.txt) — fetch this first, then the page it names.
orama deploy and domain
Deploy apps and attach custom domains. Every command and flag below comes from the orama command tree, so it matches the binary.
Global conventions are on the CLI overview.
orama deploy
Deploy applications to the Orama network
text
orama deploy
text
Deploy static sites, Next.js apps, Go backends, and Node.js backends. A name that is already deployed in the namespace is refused (409) unless you redeploy it as an update with --update.
Subcommands: go, nextjs, nodejs, static
orama deploy go
Deploy a Go backend
text
orama deploy go <source_path> [flags]
| Flag | Default | Description |
|---|---|---|
--env-file | — | Read environment variables from a .env file |
--env | — | Environment variable as KEY=VALUE (repeatable) |
--health-check | — | Path the platform polls to decide the app is up (default /health) |
--name | — | Deployment name (required) |
--subdomain | — | Custom subdomain |
--update | false | Update existing deployment |
orama deploy nextjs
Deploy a Next.js application
text
orama deploy nextjs <source_path> [flags]
| Flag | Default | Description |
|---|---|---|
--env-file | — | Read environment variables from a .env file |
--env | — | Environment variable as KEY=VALUE (repeatable) |
--health-check | — | Path the platform polls to decide the app is up (default /health) |
--name | — | Deployment name (required) |
--ssr | false | Deploy with SSR (server-side rendering) |
--subdomain | — | Custom subdomain |
--update | false | Update existing deployment |
orama deploy nodejs
Deploy a Node.js backend
text
orama deploy nodejs <source_path> [flags]
| Flag | Default | Description |
|---|---|---|
--env-file | — | Read environment variables from a .env file |
--env | — | Environment variable as KEY=VALUE (repeatable) |
--health-check | — | Path the platform polls to decide the app is up (default /health) |
--name | — | Deployment name (required) |
--subdomain | — | Custom subdomain |
--update | false | Update existing deployment |
orama deploy static
Deploy a static site (React, Vue, etc.)
text
orama deploy static <source_path> [flags]
| Flag | Default | Description |
|---|---|---|
--env-file | — | Read environment variables from a .env file |
--env | — | Environment variable as KEY=VALUE (repeatable) |
--name | — | Deployment name (required) |
--subdomain | — | Custom subdomain |
--update | false | Update existing deployment |
orama domain
Attach custom domains to your apps
text
orama domain
text
Add, verify, list and remove custom domains. A domain is proved yours with a TXT record before it serves traffic. 'add' prints the record to create, 'verify' checks it.
Subcommands: add, list, remove, verify
orama domain add
Attach a domain to an app
text
orama domain add <domain> [flags]
text
Register a domain against a deployment and print the TXT record that proves you own it. The domain does not serve traffic until 'orama domain verify' succeeds.
| Flag | Default | Description |
|---|---|---|
--app | — | Deployment to attach the domain to [required] |
--verify | false | Wait for the TXT record and verify in one step |
--wait | 5m0s | How long --verify waits for the record to propagate |
orama domain list
List your custom domains
text
orama domain list [flags]
text
List every custom domain in the namespace, or only one app's with --app.
| Flag | Default | Description |
|---|---|---|
--app | — | Only this deployment's domains |
orama domain remove
Detach a domain
text
orama domain remove <domain>
text
Remove a custom domain and the DNS record that pointed it at your app.
orama domain verify
Check the TXT record and activate the domain
text
orama domain verify <domain> [flags]
text
Ask the gateway to resolve the domain's TXT record and, if it matches, start serving the domain. With --wait the check is repeated until the record appears, which is what a freshly created DNS record needs.
| Flag | Default | Description |
|---|---|---|
--wait | 0s | Keep checking until the record appears, up to this long |