foundryctl is the Foundry command-line tool for generating and deploying SigNoz.
foundryctl [command] [flags]
| Flag | Description | Default |
|---|---|---|
-d, --debug |
Enable debug mode with verbose logging | false |
-f, --file |
Path to the casting configuration file | casting.yaml |
-p, --pours |
Directory for generated output | ./pours |
--format |
Output format for results and errors (json, text) |
json |
--no-ledger |
Disable anonymous usage ledger | false |
--no-updater |
Disable the update notifier | false |
-h, --help |
Help for foundryctl |
Tip
Use --debug when troubleshooting errors. It shows internal details that are hidden by default.
Validate that all required tools are installed for your deployment mode.
foundryctl gauge -f casting.yamlExits with an error if any required tool is missing. Run this before forge or cast to catch missing dependencies early.
Generate deployment and configuration files from your casting.
foundryctl forge -f casting.yaml -p ./poursReads the casting file, merges your overrides with defaults, and writes the generated files to the pours directory. The output depends on the deployment mode: Compose files for Docker, service units for systemd, Kubernetes manifests for Kustomize, Helm values for Helm, and so on.
After forging, a casting.yaml.lock file is written with checksums to track the current deployment state.
Deploy SigNoz to your target environment. Runs gauge and forge automatically before deploying.
foundryctl cast -f casting.yamlSkip individual steps:
# Skip tool validation
foundryctl cast --no-gauge
# Skip file generation (use existing pours)
foundryctl cast --no-forgeNote
Some deployment modes (Render, Coolify, Railway) do not support automated deployment. For these, cast generates the files and prints instructions for manual deployment on the target platform.
Generate example casting files and pours for all supported deployment modes.
# Generate example castings and forged output
foundryctl gen examples
# Generate JSON schemas
foundryctl gen schemasThis is the fastest way to get a working casting.yaml for your environment. Each example is written to docs/examples/<deployment>/ with a minimal casting file and pre-forged output.