Agent index (llms.txt) — fetch this first, then the page it names.

orama app

Inspect and manage deployed applications. Every command and flag below comes from the orama command tree, so it matches the binary.

Global conventions are on the CLI overview.

orama app

Manage deployed applications

text
orama app

Aliases: apps

text
List, get, delete, rollback, and view logs/stats for your deployed applications.

Subcommands: delete, env, get, grants, list, logs, rollback, stats

orama app delete

Delete a deployment

text
orama app delete <name>

orama app env

Manage an app's environment variables

text
orama app env
text
Read and change the environment variables a deployed app runs with.

Setting or removing a variable restarts the app, on every node that runs it,
so it picks up the change. The command succeeds only when every node applied
it. If a node could not be reached it is named in the error, still runs the old
environment, and running the same command again retries it.

Values are never printed back. They are where secrets live, so 'list' shows
names only.

Subcommands: list, set, unset

orama app env list

List an app's environment variable names

text
orama app env list <app>

orama app env set

Set environment variables and restart the app

text
orama app env set <app> [flags]
text
Set one or more variables and restart the app.

Values given with --env never appear in shell history if you read them from a
file instead: --env-file takes a .env and sends every variable in it.
FlagDefaultDescription
--env-file—Read variables from a .env file
--env—Variable as KEY=VALUE (repeatable)

orama app env unset

Remove environment variables and restart the app

text
orama app env unset <app> <KEY>...

orama app get

Get deployment details

text
orama app get <name>

orama app grants

Say what a deployed app may do, as itself

text
orama app grants
text
Read and change what a deployment is allowed to reach.

Your app is handed a short-lived token of its own at start, in the file named by
$ORAMA_TOKEN_FILE, and renews it with the gateway before it expires. It reaches
nothing until you grant it something — which is the point: an app that ships
with no credential cannot leak one.

A deployment cannot be granted the control plane. If something needs to deploy
or mint keys, that is a person or a CI key, not an app.

Subcommands: list, set

orama app grants list

Show what deployments in this namespace may do

text
orama app grants list [app]

orama app grants set

Grant a deployment a role

text
orama app grants set <app> <role> [flags]
text
Give a deployment a role in its own namespace.

  runtime  the data plane: invoke, storage, push, webrtc, proxy, pubsub, cache
  reader   nothing beyond the routes that ask for no grant

The change reaches a running app within seconds: a deployment's grant is read
wherever its token is checked (cached for 10 seconds on each node), so it needs
neither a redeploy nor a new token.
FlagDefaultDescription
--resource—Narrow the role to a resource, e.g. pubsub:topic=orders.*

orama app list

List all deployments

text
orama app list

orama app logs

Stream deployment logs

text
orama app logs <name> [flags]
FlagDefaultDescription
-f, --followfalseFollow log output
-n, --lines100Number of lines to show

orama app rollback

Rollback a deployment to a previous version

text
orama app rollback <name> [flags]
FlagDefaultDescription
--version0Version to rollback to (required)

orama app stats

Show resource usage for a deployment

text
orama app stats <name>