Menu
Deploying a Golem application. Use when asked to deploy agents to a Golem server, update running agents, or troubleshoot deployment issues.
Developing, testing, and running Golem skill tests with the skill test harness. Use when creating new skills, writing scenario YAML files, running skill tests locally, or debugging skill test failures.
Cutting a new docs version, promoting next to a release, and managing versioned documentation content under docs/src/content/. Use when releasing a new Golem version, backporting docs fixes to an older release, renaming a docs version, or adding/removing a version from the version selector.
Adding or modifying HTTP REST API endpoints in Golem services. Use when creating new endpoints, changing existing API routes, or updating request/response types for the Golem REST API.
Final checks before submitting a pull request. Use when preparing to create a PR, to ensure formatting, linting, and the correct tests have been run.
Adding a new component or agent templates to an existing Golem application. Use when adding a second component, adding agent templates like human-in-the-loop or snapshotting to an existing component, or converting a single-component app to multi-component.
Defining environment variables for Golem agents in `golem.yaml` (`env`, `envDefaults`, `secretDefaults`) or via CLI. Use when adding, setting, or overriding env vars on a component, agent, template, preset, or environment, or when wiring template substitution and merge modes.
| name | golem-deploy |
| description | Deploying a Golem application. Use when asked to deploy agents to a Golem server, update running agents, or troubleshoot deployment issues. |
golem deployBoth golem and golem-cli can be used — all commands below work with either binary.
golem deploy --yes
Run this from the application root directory (where the root golem.yaml is located). It automatically builds all components (with up-to-date checks), uploads them to the configured Golem server, and creates or updates the deployment. Always pass --yes to avoid interactive prompts.
golem deploy Doesgolem build).Existing running agents are not affected by default — they continue running with their previous component version. Use --update-agents or --redeploy-agents to change this behavior.
| Option | Description |
|---|---|
--plan | Only plan deployment, apply no changes |
--force-build | Skip modification-time based up-to-date checks |
-u, --update-agents <MODE> | Update existing agents: automatic or manual |
--redeploy-agents | Delete and recreate existing agents |
-r, --reset | Delete agents and the environment, then deploy from scratch |
-P, --preset <PRESET> | Select custom component presets |
-Y, --yes | Non-interactive mode — always use this flag |
| Option | Description |
|---|---|
-E, --environment <NAME> | Select a Golem environment by name |
-L, --local | Use local environment or profile |
-C, --cloud | Use cloud environment or profile |
--profile <PROFILE> | Select a Golem profile by name |
golem deploy --yes
Builds, uploads, and activates all components. Agents are created on first invocation.
golem deploy --yes --reset
Deletes all previously created agents and redeploys everything. Use this when iterating on code changes — without it, existing agent instances keep running with the old component version.
golem deploy --yes --update-agents automatic
Updates existing agents to the new component version automatically. Agents pick up the new code on their next invocation.
golem deploy --yes --plan
Shows what would be deployed without making any changes.
golem deploy runs the build automatically.