coolify-cli
llms.txt486 starsChanged 2 months agoMITView on GitHub
Full AI/LLM command catalog for the Coolify CLI. Manage Coolify instances (cloud and self-hosted), servers, projects, applications, databases, services, deployments, domains, and private keys. Source: https://github.com/coollabsio/coolify-cli API Spec: https://github.com/coollabsio/coolify/blob/v4.x/openapi.json Config file location: - Linux/macOS: ~/.config/coolify/config.json - Windows: %APPDATA%\coolify\config.json Supports multiple contexts (instances) with coolify context commands. All commands support --format flag: - table (default) - human-readable tabular output - json - compact JSON for scripting - pretty - indented JSON for debugging Aliases are derived from the CLI command tree:…
- Pipes a download into a shell
- Reads credentials
- Installs packages
We split this llms-full.txt into the rules it gives an agent
2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 45
All commands support --format flag:
- Distinctive: line 172
All resource identifiers use UUIDs (not internal database IDs)
≈ “Common” is an estimate: at least 1 in 5 of the 3,225 llms.txt files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Keep what fits and drop the rest. Your version, ready for your agents.
Files
llms-full.txt
# Coolify CLI - llms-full.txt
> Full AI/LLM command catalog for the Coolify CLI.
> Manage Coolify instances (cloud and self-hosted), servers, projects, applications, databases, services, deployments, domains, and private keys.
> Source: https://github.com/coollabsio/coolify-cli
> API Spec: https://github.com/coollabsio/coolify/blob/v4.x/openapi.json
## Companion Files
- Quick instructions: ./llms.txt
- Regenerate docs: `go run ./coolify docs llms`
## Installation
```bash
# Linux/macOS (recommended)
curl -fsSL https://raw.githubusercontent.com/coollabsio/coolify-cli/main/scripts/install.sh | bash
# Homebrew (macOS/Linux)
brew install coollabsio/coolify-cli/coolify-cli
# Windows (PowerShell)
irm https://raw.githubusercontent.com/coollabsio/coolify-cli/main/scripts/install.ps1 | iex
# Go install
go install github.com/coollabsio/coolify-cli/coolify@latest
```
## Authentication
1. Get an API token from your Coolify dashboard at `/security/api-tokens`
2. For Coolify Cloud: `coolify context set-token cloud <token>`
3. For self-hosted: `coolify context add -d <context_name> <url> <token>`
## Configuration
Config file location:
- Linux/macOS: `~/.config/coolify/config.json`
- Windows: `%APPDATA%\coolify\config.json`
Supports multiple contexts (instances) with `coolify context` commands.
## Output Formats
All commands support `--format` flag:
- `table` (default) - human-readable tabular output
- `json` - compact JSON for scripting
- `pretty` - indented JSON for debugging
## Command Aliases
Aliases are derived from the CLI command tree:
- `coolify app destinations` | `coolify app destination`
- `coolify app env` | `coolify app envs` | `coolify app environment`
- `coolify app previews create` | `coolify app previews open` | `coolify app previews deploy`
- `coolify app previews` | `coolify app preview`
- `coolify app secret-manager` | `coolify app secret-managers`
- `coolify app start` | `coolify app deploy`
- `coolify app storage` | `coolify app storages`
- `coolify app tag` | `coolify app tags`
- `coolify app task` | `coolify app tasks` | `coolify app scheduled-task` | `coolify app scheduled-tasks`
- `coolify app` | `coolify apps` | `coolify application` | `coolify applications`
- `coolify audit` | `coolify audit-events` | `coolify audit-log`
- `coolify cloud-init` | `coolify cloudinit` | `coolify cloud-init-script`
- `coolify cloud-token` | `coolify cloud-tokens`
- `coolify database import` | `coolify database imports`
- `coolify database storage` | `coolify database storages`
- `coolify database tag` | `coolify database tags`
- `coolify database` | `coolify databases` | `coolify db` | `coolify dbs`
- `coolify destination delete` | `coolify destination remove`
- `coolify destination` | `coolify destinations`
- `coolify github` | `coolify gh` | `coolify github-app` | `coolify github-apps`
- `coolify gitlab` | `coolify gl` | `coolify gitlab-app` | `coolify gitlab-apps`
- `coolify integration-token` | `coolify integration-tokens`
- `coolify notification` | `coolify notifications`
- `coolify private-key` | `coolify private-keys` | `coolify key` | `coolify keys`
- `coolify project environments` | `coolify project environment` | `coolify project env`
- `coolify project` | `coolify projects`
- `coolify resource` | `coolify resources`
- `coolify s3 delete` | `coolify s3 remove`
- `coolify s3` | `coolify s3-storage` | `coolify s3-storages`
- `coolify server cloudflare-tunnel` | `coolify server cf-tunnel`
- `coolify server digitalocean` | `coolify server digital-ocean` | `coolify server do`
- `coolify server domains` | `coolify server domain`
- `coolify server registry` | `coolify server registries`
- `coolify server` | `coolify servers`
- `coolify service application` | `coolify service applications` | `coolify service app` | `coolify service apps`
- `coolify service database import` | `coolify service database imports`
- `coolify service database` | `coolify service databases` | `coolify service db` | `coolify service dbs`
- `coolify service storage` | `coolify service storages`
- `coolify service tag` | `coolify service tags`
- `coolify service task` | `coolify service tasks` | `coolify service scheduled-task` | `coolify service scheduled-tasks`
- `coolify service` | `coolify services` | `coolify svc`
- `coolify shared-env environment` | `coolify shared-env env`
- `coolify shared-env` | `coolify shared-envs` | `coolify sharedenv`
- `coolify tag` | `coolify tags`
- `coolify teams current` | `coolify teams me`
- `coolify teams members` | `coolify teams member`
- `coolify teams` | `coolify team`
## Supported Database Types
When using `coolify database create <type>`:
- `postgresql`
- `mysql`
- `mariadb`
- `mongodb`
- `redis`
- `keydb`
- `clickhouse`
- `dragonfly`
## Usage Examples
```bash
# Multi-context workflow
coolify context add prod https://prod.coolify.io <token>
coolify context add staging https://staging.coolify.io <token>
coolify context use prod
coolify --context=staging server list
# Application lifecycle
coolify app list
coolify app get <uuid>
coolify app start <uuid>
coolify app stop <uuid>
coolify app restart <uuid>
coolify app logs <uuid> --follow
# Environment variable management
coolify app env list <uuid>
coolify app env create <uuid> --key API_KEY --value secret123
coolify app env sync <uuid> --file .env.production --build-time --preview
# Deploy workflows
coolify deploy name my-application
coolify deploy batch api,worker,frontend --force
coolify deploy list
coolify deploy cancel <uuid>
# Database backup
coolify database backup create <db-uuid> --frequency "0 2 * * *" --enabled --save-s3
coolify database backup trigger <db-uuid> <backup-uuid>
# Application creation
coolify app create public --project-uuid <uuid> --server-uuid <uuid> --git-repository https://github.com/user/repo --git-branch main --build-pack nixpacks --ports-exposes 3000
coolify app create dockerfile --project-uuid <uuid> --server-uuid <uuid> --dockerfile "FROM node:18\nCOPY . .\nRUN npm install\nCMD [\"node\", \"index.js\"]"
coolify app create dockerimage --project-uuid <uuid> --server-uuid <uuid> --docker-registry-image-name nginx --ports-exposes 80
# Service creation (one-click services)
coolify service create <type> --project-uuid <uuid> --server-uuid <uuid> --instant-deploy
coolify service create --list-types # list all available service types
# Storage management
coolify app storage create <app-uuid> --type persistent --mount-path /data --name my-volume
coolify app storage create <app-uuid> --type file --mount-path /app/config.yml --content "key: value"
# GitHub App integration
coolify github list
coolify github repos <app-uuid>
coolify github branches <app-uuid> owner/repo
# Team management
coolify team list
coolify team current
coolify team members list
```
## API Notes
- All resource identifiers use UUIDs (not internal database IDs)
- API base path: `/api/v1/`
- Authentication: Bearer token via `--token` flag or context configuration
- `app env sync` behavior: updates existing variables, creates missing ones, does NOT delete variables not in the file
- `app start` aliases to `app deploy` and also accepts `--force` and `--instant-deploy` flags
- Deployment logs support `--follow` for real-time streaming and `--debuglogs` for internal operations
- `app logs` defaults to 100 lines; `app deployments logs` defaults to 0 (all lines)
- Short flag `-n` can be used instead of `--lines` for log commands
- `completion` command supports shells: `bash`, `zsh`, `fish`, `powershell`
- Resource statuses: `running`, `stopped`, `error`
- Teams use numeric IDs (not UUIDs) - this is the only resource that uses IDs
- Fields marked `sensitive:"true"` (tokens, passwords, IPs, emails) are hidden by default; use `--show-sensitive` to reveal
---
## Command Reference
Command: coolify
Description: Coolify CLI
Parameters:
- name: --context
type: string
description: Use specific context by name
required: false
- name: --debug
type: boolean
description: Debug mode
required: false
default: false
- name: --format
type: string
description: Format output (table|json|pretty)
required: false
default: table
- name: --show-sensitive (-s)
type: boolean
description: Show sensitive information
required: false
default: false
- name: --token
type: string
description: Token for authentication (override context token)
required: false
Command: coolify app clone <uuid>
Description: Clone an application to a destination
Parameters:
- name: --clone-volumes
type: boolean
description: Clone volume data
required: false
default: false
- name: --destination
type: string
description: Destination UUID
required: false
- name: --name
type: string
description: Optional new name
required: false
Command: coolify app create deploy-key
Description: Create an application from a private repository using SSH deploy key
Parameters:
- name: --base-directory
type: string
description: Base directory for the application
required: false
- name: --build-command
type: string
description: Custom build command
required: false
- name: --build-pack
type: string
description: Build pack: nixpacks, static, dockerfile, dockercompose (required)
required: true
- name: --compose-domain
type: stringArray
description: Docker Compose service domain in <service>=<url>[,<url>] format (repeatable)
required: false
- name: --custom-internal-name
type: string
description: Custom internal hostname
required: false
- name: --description
type: string
description: Application description
required: false
- name: --destination-uuid
type: string
description: Destination UUID if server has multiple destinations
required: false
- name: --disable-build-cache
type: boolean
description: Disable the build cache
required: false
default: false
- name: --docker-images-to-keep
type: integer
description: Number of Docker images to retain
required: false
default: 0
- name: --dockerfile-target-build
type: string
description: Dockerfile target build stage
required: false
- name: --domains
type: string
description: Domain(s) for the application
required: false
- name: --environment-name
type: string
description: Environment name
required: false
- name: --environment-uuid
type: string
description: Environment UUID
required: false
- name: --git-branch
type: string
description: Git branch (required)
required: true
- name: --git-commit-sha
type: string
description: Specific commit SHA to deploy
required: false
- name: --git-repository
type: string
description: Git repository SSH URL, e.g., 'git@github.com:owner/repo.git' (required)
required: true
- name: --gpu-count
type: string
description: GPU count
required: false
- name: --gpu-device-ids
type: string
description: GPU device IDs
required: false
- name: --gpu-driver
type: string
description: GPU driver
required: false
- name: --gpu-options
type: string
description: GPU options
required: false
- name: --health-check-enabled
type: boolean
description: Enable health checks
required: false
default: false
- name: --health-check-path
type: string
description: Health check path
required: false
- name: --include-source-commit-in-build
type: boolean
description: Include the source commit in the build
required: false
default: false
- name: --inject-build-args-to-dockerfile
type: boolean
description: Inject build arguments into the Dockerfile
required: false
default: false
- name: --install-command
type: string
description: Custom install command
required: false
- name: --instant-deploy
type: boolean
description: Deploy immediately after creation
required: false
default: false
- name: --is-consistent-container-name-enabled
type: boolean
description: Use consistent container names
required: false
default: false
- name: --is-env-sorting-enabled
type: boolean
description: Sort environment variables
required: false
default: false
- name: --is-git-lfs-enabled
type: boolean
description: Enable Git LFS
required: false
default: false
- name: --is-git-shallow-clone-enabled
type: boolean
description: Use a shallow Git clone
required: false
default: false
- name: --is-git-submodules-enabled
type: boolean
description: Clone Git submodules
required: false
default: false
- name: --is-gpu-enabled
type: boolean
description: Enable GPU
required: false
default: false
- name: --is-gzip-enabled
type: boolean
description: Enable gzip compression
required: false
default: false
- name: --is-log-drain-enabled
type: boolean
description: Enable application log drain
required: false
default: false
- name: --is-pr-deployments-public-enabled
type: boolean
description: Make pull request deployments public
required: false
default: false
- name: --is-preview-deployments-enabled
type: boolean
description: Enable preview deployments
required: false
default: false
- name: --is-raw-compose-deployment-enabled
type: boolean
description: Deploy the raw Docker Compose definition
required: false
default: false
- name: --is-stripprefix-enabled
type: boolean
description: Enable path prefix stripping
required: false
default: false
- name: --limits-cpus
type: string
description: CPU limit
required: false
- name: --limits-memory
type: string
description: Memory limit
required: false
- name: --max-restart-count
type: integer
description: Maximum container restart count
required: false
default: 0
- name: --name
type: string
description: Application name
required: false
- name: --ports-exposes
type: string
description: Exposed ports, e.g., '3000' or '3000,8080' (required)
required: true
- name: --ports-mappings
type: string
description: Port mappings (host:container)
required: false
- name: --preview-url-template
type: string
description: Preview URL template
required: false
- name: --private-key-uuid
type: string
description: Private key UUID (required)
required: true
- name: --project-uuid
type: string
description: Project UUID (required)
required: true
- name: --publish-directory
type: string
description: Publish directory for static builds
required: false
- name: --server-uuid
type: string
description: Server UUID (required)
required: true
- name: --start-command
type: string
description: Custom start command
required: false
- name: --stop-grace-period
type: integer
description: Container stop grace period in seconds
required: false
default: 0
- name: --tag
type: stringArray
description: Tag to assign to the application (repeatable)
required: false
- name: --tags
type: stringSlice
description: Tags to assign to the application
required: false
- name: --use-build-secrets
type: boolean
description: Use Docker Build Secrets for build-time variables
required: false
default: false
Command: coolify app create dockerfile
Description: Create an application from a custom Dockerfile
Parameters:
- name: --custom-internal-name
type: string
description: Custom internal hostname
required: false
- name: --description
type: string
description: Application description
required: false
- name: --destination-uuid
type: string
description: Destination UUID if server has multiple destinations
required: false
- name: --disable-build-cache
type: boolean
description: Disable the build cache
required: false
default: false
- name: --docker-images-to-keep
type: integer
description: Number of Docker images to retain
required: false
default: 0
- name: --dockerfile
type: string
description: Dockerfile content (required)
required: true
- name: --dockerfile-target-build
type: string
description: Dockerfile target build stage
required: false
- name: --domains
type: string
description: Domain(s) for the application
required: false
- name: --environment-name
type: string
description: Environment name
required: false
- name: --environment-uuid
type: string
description: Environment UUID
required: false
- name: --gpu-count
type: string
description: GPU count
required: false
- name: --gpu-device-ids
type: string
description: GPU device IDs
required: false
- name: --gpu-driver
type: string
description: GPU driver
required: false
- name: --gpu-options
type: string
description: GPU options
required: false
- name: --health-check-enabled
type: boolean
description: Enable health checks
required: false
default: false
- name: --health-check-path
type: string
description: Health check path
required: false
- name: --include-source-commit-in-build
type: boolean
description: Include the source commit in the build
required: false
default: false
- name: --inject-build-args-to-dockerfile
type: boolean
description: Inject build arguments into the Dockerfile
required: false
default: false
- name: --instant-deploy
type: boolean
description: Deploy immediately after creation
required: false
default: false
- name: --is-consistent-container-name-enabled
type: boolean
description: Use consistent container names
required: false
default: false
- name: --is-env-sorting-enabled
type: boolean
description: Sort environment variables
required: false
default: false
- name: --is-git-lfs-enabled
type: boolean
description: Enable Git LFS
required: false
default: false
- name: --is-git-shallow-clone-enabled
type: boolean
description: Use a shallow Git clone
required: false
default: false
- name: --is-git-submodules-enabled
type: boolean
description: Clone Git submodules
required: false
default: false
- name: --is-gpu-enabled
type: boolean
description: Enable GPU
required: false
default: false
- name: --is-gzip-enabled
type: boolean
description: Enable gzip compression
required: false
default: false
- name: --is-log-drain-enabled
type: boolean
description: Enable application log drain
required: false
default: false
- name: --is-pr-deployments-public-enabled
type: boolean
description: Make pull request deployments public
required: false
default: false
- name: --is-preview-deployments-enabled
type: boolean
description: Enable preview deployments
required: false
default: false
- name: --is-raw-compose-deployment-enabled
type: boolean
description: Deploy the raw Docker Compose definition
required: false
default: false
- name: --is-stripprefix-enabled
type: boolean
description: Enable path prefix stripping
required: false
default: false
- name: --limits-cpus
type: string
description: CPU limit
required: false
- name: --limits-memory
type: string
description: Memory limit
required: false
- name: --max-restart-count
type: integer
description: Maximum container restart count
required: false
default: 0
- name: --name
type: string
description: Application name
required: false
- name: --ports-exposes
type: string
description: Exposed ports, e.g., '3000' or '3000,8080'
required: false
- name: --ports-mappings
type: string
description: Port mappings (host:container)
required: false
- name: --preview-url-template
type: string
description: Preview URL template
required: false
- name: --project-uuid
type: string
description: Project UUID (required)
required: true
- name: --server-uuid
type: string
description: Server UUID (required)
required: true
- name: --stop-grace-period
type: integer
description: Container stop grace period in seconds
required: false
default: 0
- name: --tag
type: stringArray
description: Tag to assign to the application (repeatable)
required: false
- name: --tags
type: stringSlice
description: Tags to assign to the application
required: false
- name: --use-build-secrets
type: boolean
description: Use Docker Build Secrets for build-time variables
required: false
default: false
Command: coolify app create dockerimage
Description: Create an application from a pre-built Docker image
Parameters:
- name: --custom-internal-name
type: string
description: Custom internal hostname
required: false
- name: --description
type: string
description: Application description
required: false
- name: --destination-uuid
type: string
description: Destination UUID if server has multiple destinations
required: false
- name: --disable-build-cache
type: boolean
description: Disable the build cache
required: false
default: false
- name: --docker-images-to-keep
type: integer
description: Number of Docker images to retain
required: false
default: 0
- name: --docker-registry-image-name
type: string
description: Docker image name from registry (required)
required: true
- name: --docker-registry-image-tag
type: string
description: Docker image tag (defaults to 'latest')
required: false
- name: --dockerfile-target-build
type: string
description: Dockerfile target build stage
required: false
- name: --domains
type: string
description: Domain(s) for the application
required: false
- name: --environment-name
type: string
description: Environment name
required: false
- name: --environment-uuid
type: string
description: Environment UUID
required: false
- name: --gpu-count
type: string
description: GPU count
required: false
- name: --gpu-device-ids
type: string
description: GPU device IDs
required: false
- name: --gpu-driver
type: string
description: GPU driver
required: false
- name: --gpu-options
type: string
description: GPU options
required: false
- name: --health-check-enabled
type: boolean
description: Enable health checks
required: false
default: false
- name: --health-check-path
type: string
description: Health check path
required: false
- name: --include-source-commit-in-build
type: boolean
description: Include the source commit in the build
required: false
default: false
- name: --inject-build-args-to-dockerfile
type: boolean
description: Inject build arguments into the Dockerfile
required: false
default: false
- name: --instant-deploy
type: boolean
description: Deploy immediately after creation
required: false
default: false
- name: --is-consistent-container-name-enabled
type: boolean
description: Use consistent container names
required: false
default: false
- name: --is-env-sorting-enabled
type: boolean
description: Sort environment variables
required: false
default: false
- name: --is-git-lfs-enabled
type: boolean
description: Enable Git LFS
required: false
default: false
- name: --is-git-shallow-clone-enabled
type: boolean
description: Use a shallow Git clone
required: false
default: false
- name: --is-git-submodules-enabled
type: boolean
description: Clone Git submodules
required: false
default: false
- name: --is-gpu-enabled
type: boolean
description: Enable GPU
required: false
default: false
- name: --is-gzip-enabled
type: boolean
description: Enable gzip compression
required: false
default: false
- name: --is-log-drain-enabled
type: boolean
description: Enable application log drain
required: false
default: false
- name: --is-pr-deployments-public-enabled
type: boolean
description: Make pull request deployments public
required: false
default: false
- name: --is-preview-deployments-enabled
type: boolean
description: Enable preview deployments
required: false
default: false
- name: --is-raw-compose-deployment-enabled
type: boolean
description: Deploy the raw Docker Compose definition
required: false
default: false
- name: --is-stripprefix-enabled
type: boolean
description: Enable path prefix stripping
required: false
default: false
- name: --limits-cpus
type: string
description: CPU limit
required: false
- name: --limits-memory
type: string
description: Memory limit
required: false
- name: --max-restart-count
type: integer
description: Maximum container restart count
required: false
default: 0
- name: --name
type: string
description: Application name
required: false
- name: --ports-exposes
type: string
description: Exposed ports, e.g., '80' or '80,443' (required)
required: true
- name: --ports-mappings
type: string
description: Port mappings (host:container)
required: false
- name: --preview-url-template
type: string
description: Preview URL template
required: false
- name: --project-uuid
type: string
description: Project UUID (required)
required: true
- name: --server-uuid
type: string
description: Server UUID (required)
required: true
- name: --stop-grace-period
type: integer
description: Container stop grace period in seconds
required: false
default: 0
- name: --tag
type: stringArray
description: Tag to assign to the application (repeatable)
required: false
- name: --tags
type: stringSlice
description: Tags to assign to the application
required: false
- name: --use-build-secrets
type: boolean
description: Use Docker Build Secrets for build-time variables
required: false
default: false
Command: coolify app create github
Description: Create an application from a private repository using GitHub App
Parameters:
- name: --base-directory
type: string
description: Base directory for the application
required: false
- name: --build-command
type: string
description: Custom build command
required: false
- name: --build-pack
type: string
description: Build pack: nixpacks, static, dockerfile, dockercompose (required)
required: true
- name: --compose-domain
type: stringArray
description: Docker Compose service domain in <service>=<url>[,<url>] format (repeatable)
required: false
- name: --custom-internal-name
type: string
description: Custom internal hostname
required: false
- name: --description
type: string
description: Application description
required: false
- name: --destination-uuid
type: string
description: Destination UUID if server has multiple destinations
required: false
- name: --disable-build-cache
type: boolean
description: Disable the build cache
required: false
default: false
- name: --docker-images-to-keep
type: integer
description: Number of Docker images to retain
required: false
default: 0
- name: --dockerfile-target-build
type: string
description: Dockerfile target build stage
required: false
- name: --domains
type: string
description: Domain(s) for the application
required: false
- name: --environment-name
type: string
description: Environment name
required: false
- name: --environment-uuid
type: string
description: Environment UUID
required: false
- name: --git-branch
type: string
description: Git branch (required)
required: true
- name: --git-commit-sha
type: string
description: Specific commit SHA to deploy
required: false
- name: --git-repository
type: string
description: Git repository in format 'owner/repo' (required)
required: true
- name: --github-app-uuid
type: string
description: GitHub App UUID (required)
required: true
- name: --gpu-count
type: string
description: GPU count
required: false
- name: --gpu-device-ids
type: string
description: GPU device IDs
required: false
- name: --gpu-driver
type: string
description: GPU driver
required: false
- name: --gpu-options
type: string
description: GPU options
required: false
- name: --health-check-enabled
type: boolean
description: Enable health checks
required: false
default: false
- name: --health-check-path
type: string
description: Health check path
required: false
- name: --include-source-commit-in-build
type: boolean
description: Include the source commit in the build
required: false
default: false
- name: --inject-build-args-to-dockerfile
type: boolean
description: Inject build arguments into the Dockerfile
required: false
default: false
- name: --install-command
type: string
description: Custom install command
required: false
- name: --instant-deploy
type: boolean
description: Deploy immediately after creation
required: false
default: false
- name: --is-consistent-container-name-enabled
type: boolean
description: Use consistent container names
required: false
default: false
- name: --is-env-sorting-enabled
type: boolean
description: Sort environment variables
required: false
default: false
- name: --is-git-lfs-enabled
type: boolean
description: Enable Git LFS
required: false
default: false
- name: --is-git-shallow-clone-enabled
type: boolean
description: Use a shallow Git clone
required: false
default: false
- name: --is-git-submodules-enabled
type: boolean
description: Clone Git submodules
required: false
default: false
- name: --is-gpu-enabled
type: boolean
description: Enable GPU
required: false
default: false
- name: --is-gzip-enabled
type: boolean
description: Enable gzip compression
required: false
default: false
- name: --is-log-drain-enabled
type: boolean
description: Enable application log drain
required: false
default: false
- name: --is-pr-deployments-public-enabled
type: boolean
description: Make pull request deployments public
required: false
default: false
- name: --is-preview-deployments-enabled
type: boolean
description: Enable preview deployments
required: false
default: false
- name: --is-raw-compose-deployment-enabled
type: boolean
description: Deploy the raw Docker Compose definition
required: false
default: false
- name: --is-stripprefix-enabled
type: boolean
description: Enable path prefix stripping
required: false
default: false
- name: --limits-cpus
type: string
description: CPU limit
required: false
- name: --limits-memory
type: string
description: Memory limit
required: false
- name: --max-restart-count
type: integer
description: Maximum container restart count
required: false
default: 0
- name: --name
type: string
description: Application name
required: false
- name: --ports-exposes
type: string
description: Exposed ports, e.g., '3000' or '3000,8080' (required)
required: true
- name: --ports-mappings
type: string
description: Port mappings (host:container)
required: false
- name: --preview-url-template
type: string
description: Preview URL template
required: false
- name: --project-uuid
type: string
description: Project UUID (required)
required: true
- name: --publish-directory
type: string
description: Publish directory for static builds
required: false
- name: --server-uuid
type: string
description: Server UUID (required)
required: true
- name: --start-command
type: string
description: Custom start command
required: false
- name: --stop-grace-period
type: integer
description: Container stop grace period in seconds
required: false
default: 0
- name: --tag
type: stringArray
description: Tag to assign to the application (repeatable)
required: false
- name: --tags
type: stringSlice
description: Tags to assign to the application
required: false
- name: --use-build-secrets
type: boolean
description: Use Docker Build Secrets for build-time variables
required: false
default: false
Command: coolify app create public
Description: Create an application from a public git repository
Parameters:
- name: --base-directory
type: string
description: Base directory for the application
required: false
- name: --build-command
type: string
description: Custom build command
required: false
- name: --build-pack
type: string
description: Build pack: nixpacks, static, dockerfile, dockercompose (required)
required: true
- name: --compose-domain
type: stringArray
description: Docker Compose service domain in <service>=<url>[,<url>] format (repeatable)
required: false
- name: --custom-internal-name
type: string
description: Custom internal hostname
required: false
- name: --description
type: string
description: Application description
required: false
- name: --destination-uuid
type: string
description: Destination UUID if server has multiple destinations
required: false
- name: --disable-build-cache
type: boolean
description: Disable the build cache
required: false
default: false
- name: --docker-images-to-keep
type: integer
description: Number of Docker images to retain
required: false
default: 0
- name: --dockerfile-target-build
type: string
description: Dockerfile target build stage
required: false
- name: --domains
type: string
description: Domain(s) for the application
required: false
- name: --environment-name
type: string
description: Environment name
required: false
- name: --environment-uuid
type: string
description: Environment UUID
required: false
- name: --git-branch
type: string
description: Git branch (required)
required: true
- name: --git-commit-sha
type: string
description: Specific commit SHA to deploy
required: false
- name: --git-repository
type: string
description: Git repository URL (required)
required: true
- name: --gpu-count
type: string
description: GPU count
required: false
- name: --gpu-device-ids
type: string
description: GPU device IDs
required: false
- name: --gpu-driver
type: string
description: GPU driver
required: false
- name: --gpu-options
type: string
description: GPU options
required: false
- name: --health-check-enabled
type: boolean
description: Enable health checks
required: false
default: false
- name: --health-check-path
type: string
description: Health check path
required: false
- name: --include-source-commit-in-build
type: boolean
description: Include the source commit in the build
required: false
default: false
- name: --inject-build-args-to-dockerfile
type: boolean
description: Inject build arguments into the Dockerfile
required: false
default: false
- name: --install-command
type: string
description: Custom install command
required: false
- name: --instant-deploy
type: boolean
description: Deploy immediately after creation
required: false
default: false
- name: --is-consistent-container-name-enabled
type: boolean
description: Use consistent container names
required: false
default: false
- name: --is-env-sorting-enabled
type: boolean
description: Sort environment variables
required: false
default: false
- name: --is-git-lfs-enabled
type: boolean
description: Enable Git LFS
required: false
default: false
- name: --is-git-shallow-clone-enabled
type: boolean
description: Use a shallow Git clone
required: false
default: false
- name: --is-git-submodules-enabled
type: boolean
description: Clone Git submodules
required: false
default: false
- name: --is-gpu-enabled
type: boolean
description: Enable GPU
required: false
default: false
- name: --is-gzip-enabled
type: boolean
description: Enable gzip compression
required: false
default: false
- name: --is-log-drain-enabled
type: boolean
description: Enable application log drain
required: false
default: false
- name: --is-pr-deployments-public-enabled
type: boolean
description: Make pull request deployments public
required: false
default: false
- name: --is-preview-deployments-enabled
type: boolean
description: Enable preview deployments
required: false
default: false
- name: --is-raw-compose-deployment-enabled
type: boolean
description: Deploy the raw Docker Compose definition
required: false
default: false
- name: --is-stripprefix-enabled
type: boolean
description: Enable path prefix stripping
required: false
default: false
- name: --limits-cpus
type: string
description: CPU limit
required: false
- name: --limits-memory
type: string
description: Memory limit
required: false
- name: --max-restart-count
type: integer
description: Maximum container restart count
required: false
default: 0
- name: --name
type: string
description: Application name
required: false
- name: --ports-exposes
type: string
description: Exposed ports, e.g., '3000' or '3000,8080' (required)
required: true
- name: --ports-mappings
type: string
description: Port mappings (host:container)
required: false
- name: --preview-url-template
type: string
description: Preview URL template
required: false
- name: --project-uuid
type: string
description: Project UUID (required)
required: true
- name: --publish-directory
type: string
description: Publish directory for static builds
required: false
- name: --server-uuid
type: string
description: Server UUID (required)
required: true
- name: --start-command
type: string
description: Custom start command
required: false
- name: --stop-grace-period
type: integer
description: Container stop grace period in seconds
required: false
default: 0
- name: --tag
type: stringArray
description: Tag to assign to the application (repeatable)
required: false
- name: --tags
type: stringSlice
description: Tags to assign to the application
required: false
- name: --use-build-secrets
type: boolean
description: Use Docker Build Secrets for build-time variables
required: false
default: false
Command: coolify app delete <uuid>
Description: Delete an application. This action cannot be undone.
Parameters:
- name: --force (-f)
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify app deployments list <app-uuid>
Description: Retrieve a list of all deployments for a specific application.
Parameters: (None)
Command: coolify app deployments logs <app-uuid> [deployment-uuid]
Description: Get deployment logs for an application
Parameters:
- name: --debuglogs
type: boolean
description: Show debug logs (includes hidden commands and internal operations)
required: false
default: false
- name: --follow (-f)
type: boolean
description: Follow log output (like tail -f)
required: false
default: false
- name: --lines (-n)
type: integer
description: Number of log lines to display (0 = all)
required: false
default: 0
Command: coolify app destinations add <uuid>
Description: Attach a destination
Parameters:
- name: --destination
type: string
description: Destination UUID
required: false
Command: coolify app destinations list <uuid>
Description: List application destinations
Parameters: (None)
Command: coolify app destinations remove <uuid> <destination_uuid>
Description: Detach a destination
Parameters: (None)
Command: coolify app env create <app_uuid>
Description: Create a new environment variable for a specific application. Use --key and --value flags to specify the variable.
Parameters:
- name: --build-time
type: boolean
description: Available at build time (default: true)
required: false
default: true
- name: --comment
type: string
description: Comment for the environment variable
required: false
- name: --is-literal
type: boolean
description: Treat value as literal (don't interpolate variables)
required: false
default: false
- name: --is-multiline
type: boolean
description: Value is multiline
required: false
default: false
- name: --key
type: string
description: Environment variable key (required)
required: true
- name: --preview
type: boolean
description: Available in preview deployments
required: false
default: false
- name: --runtime
type: boolean
description: Available at runtime (default: true)
required: false
default: true
- name: --value
type: string
description: Environment variable value (required)
required: true
Command: coolify app env delete <app_uuid> <env_uuid>
Description: Delete an environment variable from an application. First UUID is the application, second is the specific environment variable to delete.
Parameters:
- name: --force
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify app env get <app_uuid> <env_uuid_or_key>
Description: Get detailed information about a specific environment variable by UUID or key name.
Parameters: (None)
Command: coolify app env list <app_uuid>
Description: List all environment variables for an application
Parameters:
- name: --all
type: boolean
description: Show all environment variables (non-preview first, then preview)
required: false
default: false
- name: --preview
type: boolean
description: Show preview environment variables instead of regular ones
required: false
default: false
Command: coolify app env sync <app_uuid>
Description: Sync environment variables from a .env file
Parameters:
- name: --build-time
type: boolean
description: Make all variables available at build time (default: true)
required: false
default: true
- name: --file (-f)
type: string
description: Path to .env file (required)
required: true
- name: --is-literal
type: boolean
description: Treat all values as literal (don't interpolate variables)
required: false
default: false
- name: --preview
type: boolean
description: Make all variables available in preview deployments
required: false
default: false
- name: --runtime
type: boolean
description: Make all variables available at runtime (default: true)
required: false
default: true
Command: coolify app env update <app_uuid> <env_uuid_or_key>
Description: Update an existing environment variable. Identify it by UUID or key name.
Parameters:
- name: --build-time
type: boolean
description: Available at build time (default: true)
required: false
default: true
- name: --comment
type: string
description: Comment for the environment variable
required: false
- name: --is-literal
type: boolean
description: Treat value as literal
required: false
default: false
- name: --is-multiline
type: boolean
description: Value is multiline
required: false
default: false
- name: --key
type: string
description: New environment variable key (rename)
required: false
- name: --preview
type: boolean
description: Available in preview deployments
required: false
default: false
- name: --runtime
type: boolean
description: Available at runtime (default: true)
required: false
default: true
- name: --value
type: string
description: New environment variable value (required)
required: true
Command: coolify app execute-task <app_uuid> <task_uuid>
Description: Execute a scheduled task now
Parameters: (None)
Command: coolify app get <uuid>
Description: Retrieve detailed information about a specific application.
Parameters: (None)
Command: coolify app list
Description: List all applications in Coolify.
Parameters: (None)
Command: coolify app logs <uuid>
Description: Get application logs
Parameters:
- name: --follow (-f)
type: boolean
description: Follow log output (like tail -f)
required: false
default: false
- name: --lines (-n)
type: integer
description: Number of log lines to retrieve
required: false
default: 100
- name: --service
type: string
description: Docker Compose service name (selects one container in multi-service apps)
required: false
- name: --show-timestamps
type: boolean
description: Show timestamps in log output
required: false
default: false
Command: coolify app move <uuid>
Description: Move an application to another environment
Parameters:
- name: --environment-uuid
type: string
description: Target environment UUID (required)
required: true
Command: coolify app previews create <app_uuid> <pr_id>
Description: Open or redeploy a preview deployment
Parameters:
- name: --commit
type: string
description: Commit SHA to deploy (required for Bitbucket)
required: false
- name: --docker-tag
type: string
description: Docker image tag (Docker Image applications only)
required: false
- name: --force
type: boolean
description: Rebuild without cache
required: false
default: false
- name: --git-type
type: string
description: Git provider of the pull request: github, gitlab, gitea, or bitbucket
required: false
- name: --no-deploy
type: boolean
description: Only create the preview, do not queue a deployment
required: false
default: false
- name: --url
type: string
description: Pull request URL
required: false
Command: coolify app previews delete <app_uuid> <pr_id>
Description: Delete a preview deployment for an application. First argument is the application UUID, second is the pull request ID.
Parameters:
- name: --force
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify app previews get <app_uuid> <pr_id>
Description: Get a preview deployment of an application by pull request ID.
Parameters: (None)
Command: coolify app previews list <app_uuid>
Description: List the preview deployments of an application, newest pull request first.
Parameters: (None)
Command: coolify app previews logs <app_uuid> <pr_id>
Description: Get preview deployment logs
Parameters:
- name: --follow (-f)
type: boolean
description: Follow log output (like tail -f)
required: false
default: false
- name: --lines (-n)
type: integer
description: Number of log lines to retrieve (-1 for all)
required: false
default: 100
- name: --service
type: string
description: Docker Compose service name (selects one container in multi-service apps)
required: false
- name: --show-timestamps
type: boolean
description: Show timestamps in log output
required: false
default: false
Command: coolify app previews update <app_uuid> <pr_id>
Description: Update the domains of a preview deployment
Parameters:
- name: --compose-domain
type: stringArray
description: Docker Compose service domain in <service>=<url>[,<url>] format (repeatable)
required: false
- name: --domains
type: string
description: Domains (comma-separated)
required: false
- name: --force-domain-override
type: boolean
description: Save the domains even when another resource uses them
required: false
default: false
Command: coolify app restart <uuid>
Description: Restart a running application.
Parameters: (None)
Command: coolify app rollback images <uuid>
Description: List rollback images
Parameters: (None)
Command: coolify app rollback run <uuid>
Description: Rollback application to a commit
Parameters:
- name: --commit
type: string
description: Git commit SHA
required: false
Command: coolify app run-storage-backup <uuid> <storage_uuid>
Description: Run volume backup schedule now
Parameters: (None)
Command: coolify app secret-manager set <app_uuid>
Description: Set the secret manager source of an application
Parameters:
- name: --integration-token
type: string
description: UUID of the secret manager integration token (required)
required: true
- name: --settings
type: string
description: Provider settings as a JSON object
required: false
Command: coolify app start <uuid>
Description: Start an application (initiates a deployment).
Parameters:
- name: --force
type: boolean
description: Force rebuild
required: false
default: false
- name: --instant-deploy
type: boolean
description: Instant deploy (skip queuing)
required: false
default: false
Command: coolify app stop <uuid>
Description: Stop a running application.
Parameters: (None)
Command: coolify app storage create <app_uuid>
Description: Create a storage for an application
Parameters:
- name: --content
type: string
description: File content (file only)
required: false
- name: --fs-path
type: string
description: Host directory path (file only, required when --is-directory is set)
required: false
- name: --host-path
type: string
description: Host path (persistent only)
required: false
- name: --is-directory
type: boolean
description: Whether this is a directory mount (file only)
required: false
default: false
- name: --mount-path
type: string
description: Mount path inside the container (required)
required: true
- name: --name
type: string
description: Volume name (persistent only)
required: false
- name: --type
type: string
description: Storage type: 'persistent' or 'file' (required)
required: true
Command: coolify app storage delete <app_uuid> <storage_uuid>
Description: Delete a storage from an application
Parameters: (None)
Command: coolify app storage delete-backup <app_uuid> <storage_uuid>
Description: Delete storage volume backup schedule
Parameters: (None)
Command: coolify app storage list <app_uuid>
Description: List all persistent volumes and file storages for a specific application.
Parameters: (None)
Command: coolify app storage run-backup <app_uuid> <storage_uuid>
Description: Run storage volume backup now
Parameters: (None)
Command: coolify app storage set-backup <app_uuid> <storage_uuid>
Description: Create or replace storage volume backup schedule
Parameters:
- name: --disable-local-backup
type: boolean
description: Disable local backup retention
required: false
default: false
- name: --enabled
type: boolean
description: Enable the schedule
required: false
default: true
- name: --frequency
type: string
description: Cron frequency (required)
required: true
- name: --retention-amount-locally
type: integer
description: Local retention count
required: false
default: 7
- name: --retention-amount-s3
type: integer
description: S3 retention count
required: false
default: 7
- name: --retention-days-locally
type: integer
description: Local retention days
required: false
default: 0
- name: --retention-days-s3
type: integer
description: S3 retention days
required: false
default: 0
- name: --retention-max-storage-locally
type: float64
description: Local max storage
required: false
default: 0
- name: --retention-max-storage-s3
type: float64
description: S3 max storage
required: false
default: 0
- name: --s3-storage-uuid
type: string
description: S3 storage UUID when --save-s3 is set
required: false
- name: --save-s3
type: boolean
description: Also save backups to S3
required: false
default: false
- name: --stop-during-backup
type: boolean
description: Stop resource during backup
required: false
default: false
- name: --timeout
type: integer
description: Backup timeout seconds
required: false
default: 3600
Command: coolify app storage update <app_uuid>
Description: Update a storage for an application
Parameters:
- name: --content
type: string
description: File content (file only)
required: false
- name: --host-path
type: string
description: Host path (persistent only)
required: false
- name: --id
type: integer
description: Storage ID (deprecated, use --uuid instead)
required: false
default: 0
- name: --is-preview-suffix-enabled
type: boolean
description: Enable preview suffix for this storage
required: false
default: false
- name: --mount-path
type: string
description: Mount path inside the container
required: false
- name: --name
type: string
description: Storage name (persistent only)
required: false
- name: --type
type: string
description: Storage type: 'persistent' or 'file' (required)
required: true
- name: --uuid
type: string
description: Storage UUID (required, use 'storage list' to find)
required: false
Command: coolify app tag add <application-uuid> <name>
Description: Add an application tag
Parameters: (None)
Command: coolify app tag list <application-uuid>
Description: List application tags
Parameters: (None)
Command: coolify app tag remove <application-uuid> <tag-uuid>
Description: Remove an application tag
Parameters: (None)
Command: coolify app task create <app_uuid>
Description: Create a scheduled task for an application
Parameters:
- name: --command
type: string
description: Command to run (required)
required: true
- name: --container
type: string
description: Container name to run the command in
required: false
- name: --enabled
type: boolean
description: Whether the task is enabled
required: false
default: true
- name: --frequency
type: string
description: Cron expression or frequency (required)
required: true
- name: --name
type: string
description: Task name (required)
required: true
- name: --timeout
type: integer
description: Timeout in seconds
required: false
default: 300
Command: coolify app task delete <app_uuid> <task_uuid>
Description: Delete an application scheduled task
Parameters: (None)
Command: coolify app task execute <app_uuid> <task_uuid>
Description: Execute an application scheduled task now
Parameters: (None)
Command: coolify app task executions <app_uuid> <task_uuid>
Description: List executions for an application scheduled task
Parameters: (None)
Command: coolify app task list <app_uuid>
Description: List scheduled tasks for an application
Parameters: (None)
Command: coolify app task update <app_uuid> <task_uuid>
Description: Update an application scheduled task
Parameters:
- name: --command
type: string
description: Command to run
required: false
- name: --container
type: string
description: Container name to run the command in
required: false
- name: --enabled
type: boolean
description: Whether the task is enabled
required: false
default: true
- name: --frequency
type: string
description: Cron expression or frequency
required: false
- name: --name
type: string
description: Task name
required: false
- name: --timeout
type: integer
description: Timeout in seconds
required: false
default: 300
Command: coolify app update <uuid>
Description: Update application configuration
Parameters:
- name: --base-directory
type: string
description: Base directory
required: false
- name: --build-command
type: string
description: Build command
required: false
- name: --compose-domain
type: stringArray
description: Docker Compose service domain in <service>=<url>[,<url>] format (repeatable)
required: false
- name: --custom-internal-name
type: string
description: Custom internal hostname
required: false
- name: --description
type: string
description: Application description
required: false
- name: --disable-build-cache
type: boolean
description: Disable the build cache
required: false
default: false
- name: --docker-image
type: string
description: Docker image name
required: false
- name: --docker-images-to-keep
type: integer
description: Number of Docker images to retain
required: false
default: 0
- name: --docker-tag
type: string
description: Docker image tag
required: false
- name: --dockerfile
type: string
description: Dockerfile content
required: false
- name: --dockerfile-target-build
type: string
description: Dockerfile target build stage
required: false
- name: --domains
type: string
description: Domains (comma-separated)
required: false
- name: --git-branch
type: string
description: Git branch
required: false
- name: --git-repository
type: string
description: Git repository URL
required: false
- name: --gpu-count
type: string
description: GPU count
required: false
- name: --gpu-device-ids
type: string
description: GPU device IDs
required: false
- name: --gpu-driver
type: string
description: GPU driver
required: false
- name: --gpu-options
type: string
description: GPU options
required: false
- name: --health-check-enabled
type: boolean
description: Enable health check
required: false
default: false
- name: --health-check-path
type: string
description: Health check path
required: false
- name: --include-source-commit-in-build
type: boolean
description: Include the source commit in the build
required: false
default: false
- name: --inject-build-args-to-dockerfile
type: boolean
description: Inject build arguments into the Dockerfile
required: false
default: false
- name: --install-command
type: string
description: Install command
required: false
- name: --is-consistent-container-name-enabled
type: boolean
description: Use consistent container names
required: false
default: false
- name: --is-env-sorting-enabled
type: boolean
description: Sort environment variables
required: false
default: false
- name: --is-git-lfs-enabled
type: boolean
description: Enable Git LFS
required: false
default: false
- name: --is-git-shallow-clone-enabled
type: boolean
description: Use a shallow Git clone
required: false
default: false
- name: --is-git-submodules-enabled
type: boolean
description: Clone Git submodules
required: false
default: false
- name: --is-gpu-enabled
type: boolean
description: Enable GPU
required: false
default: false
- name: --is-gzip-enabled
type: boolean
description: Enable gzip compression
required: false
default: false
- name: --is-log-drain-enabled
type: boolean
description: Enable application log drain
required: false
default: false
- name: --is-pr-deployments-public-enabled
type: boolean
description: Make pull request deployments public
required: false
default: false
- name: --is-preview-deployments-enabled
type: boolean
description: Enable preview deployments
required: false
default: false
- name: --is-raw-compose-deployment-enabled
type: boolean
description: Deploy the raw Docker Compose definition
required: false
default: false
- name: --is-stripprefix-enabled
type: boolean
description: Enable path prefix stripping
required: false
default: false
- name: --max-restart-count
type: integer
description: Maximum container restart count
required: false
default: 0
- name: --name
type: string
description: Application name
required: false
- name: --ports-exposes
type: string
description: Exposed ports
required: false
- name: --ports-mappings
type: string
description: Port mappings
required: false
- name: --preview-url-template
type: string
description: Preview URL template
required: false
- name: --publish-directory
type: string
description: Publish directory
required: false
- name: --start-command
type: string
description: Start command
required: false
- name: --stop-grace-period
type: integer
description: Container stop grace period in seconds
required: false
default: 0
- name: --use-build-secrets
type: boolean
description: Use Docker Build Secrets for build-time variables
required: false
default: false
Command: coolify audit list
Description: List audit events, newest first
Parameters:
- name: --action
type: string
description: Filter by action, e.g. created, updated, deleted (all = every action)
required: false
- name: --page
type: integer
description: Page number
required: false
default: 1
- name: --per-page
type: integer
description: Events per page (1-100)
required: false
default: 25
- name: --search
type: string
description: Search text
required: false
- name: --source
type: string
description: Filter by source: all, ui, api, mcp, webhook, system, scheduler
required: false
Command: coolify cloud-init create
Description: Create a cloud-init script
Parameters:
- name: --name
type: string
description: Script name
required: false
- name: --script
type: string
description: Script contents
required: false
- name: --script-file
type: string
description: Read script contents from file
required: false
Command: coolify cloud-init delete <uuid>
Description: Delete a cloud-init script
Parameters: (None)
Command: coolify cloud-init get <uuid>
Description: Get a cloud-init script
Parameters: (None)
Command: coolify cloud-init list
Description: List cloud-init scripts
Parameters: (None)
Command: coolify cloud-init update <uuid>
Description: Update a cloud-init script
Parameters:
- name: --name
type: string
description: Script name
required: false
- name: --script
type: string
description: Script contents
required: false
- name: --script-file
type: string
description: Read script contents from file
required: false
Command: coolify cloud-token create
Description: Create a cloud provider token
Parameters:
- name: --name
type: string
description: Friendly token name
required: false
- name: --provider
type: string
description: Cloud provider: hetzner, digitalocean, or vultr
required: false
- name: --provider-token
type: string
description: Provider API token (sensitive; never included in output)
required: false
Command: coolify cloud-token delete <uuid>
Description: Delete a cloud provider token
Parameters: (None)
Command: coolify cloud-token get <uuid>
Description: Show a cloud provider token
Parameters: (None)
Command: coolify cloud-token list
Description: List cloud provider tokens
Parameters: (None)
Command: coolify cloud-token update <uuid>
Description: Rename a cloud provider token
Parameters:
- name: --name
type: string
description: New friendly token name
required: false
Command: coolify cloud-token validate <uuid>
Description: Validate a cloud provider token
Parameters: (None)
Command: coolify completion <shell>
Description: Output shell completion code for the specified shell
Parameters: (None)
Command: coolify config
Description: Display the path to the Coolify CLI configuration file
Parameters: (None)
Command: coolify context add <context_name> <url> <token>
Description: Add a new context
Parameters:
- name: --default (-d)
type: boolean
description: Set as default context
required: false
default: false
- name: --force (-f)
type: boolean
description: Force overwrite if context already exists
required: false
default: false
Command: coolify context delete <context_name>
Description: Delete a context
Parameters: (None)
Command: coolify context get <context_name>
Description: Get details of a specific context
Parameters: (None)
Command: coolify context list
Description: List all configured contexts
Parameters: (None)
Command: coolify context set-default <context_name>
Description: Set a context as the default
Parameters: (None)
Command: coolify context set-token <context_name> <token>
Description: Update the API token for a context
Parameters: (None)
Command: coolify context update <context_name>
Description: Update a context's properties (name, URL, token)
Parameters:
- name: --name (-n)
type: string
description: New name for the context
required: false
- name: --token (-t)
type: string
description: New token for the context
required: false
- name: --url (-u)
type: string
description: New URL for the context
required: false
Command: coolify context use <context_name>
Description: Switch to a different context (set as default)
Parameters: (None)
Command: coolify context verify
Description: Verify current context connection and authentication
Parameters: (None)
Command: coolify context version
Description: Get current context's Coolify version
Parameters: (None)
Command: coolify database backup create <database_uuid>
Description: Create a new scheduled backup configuration
Parameters:
- name: --databases-to-backup
type: string
description: Comma-separated list of databases to backup
required: false
- name: --disable-local-backup
type: boolean
description: Disable local backup storage
required: false
default: false
- name: --dump-all
type: boolean
description: Dump all databases
required: false
default: false
- name: --enabled
type: boolean
description: Enable backup schedule
required: false
default: false
- name: --frequency
type: string
description: Backup frequency (cron expression, e.g., '0 0 * * *' for daily)
required: false
- name: --retention-amount-locally
type: integer
description: Number of backups to retain locally
required: false
default: 0
- name: --retention-amount-s3
type: integer
description: Number of backups to retain in S3
required: false
default: 0
- name: --retention-days-locally
type: integer
description: Days to retain backups locally
required: false
default: 0
- name: --retention-days-s3
type: integer
description: Days to retain backups in S3
required: false
default: 0
- name: --retention-max-storage-locally
type: float64
description: Max storage for local backups (GB)
required: false
default: 0
- name: --retention-max-storage-s3
type: float64
description: Max storage for S3 backups (GB)
required: false
default: 0
- name: --s3-storage-uuid
type: string
description: S3 storage UUID
required: false
- name: --save-s3
type: boolean
description: Save backups to S3
required: false
default: false
- name: --timeout
type: integer
description: Backup timeout in seconds
required: false
default: 0
Command: coolify database backup delete <database_uuid> <backup_uuid>
Description: Delete a backup configuration and optionally all its executions from S3. First UUID is the database, second is the specific backup configuration.
Parameters:
- name: --delete-s3
type: boolean
description: Delete backup files from S3
required: false
default: false
Command: coolify database backup delete-execution <database_uuid> <backup_uuid> <execution_uuid>
Description: Delete a specific backup execution and optionally from S3. First UUID is the database, second is the backup configuration, third is the specific execution.
Parameters:
- name: --delete-s3
type: boolean
description: Delete backup file from S3
required: false
default: false
Command: coolify database backup executions <database_uuid> <backup_uuid>
Description: List all executions for a backup configuration. First UUID is the database, second is the specific backup configuration.
Parameters: (None)
Command: coolify database backup list <database_uuid>
Description: List all backup configurations for a specific database.
Parameters: (None)
Command: coolify database backup trigger <database_uuid> <backup_uuid>
Description: Trigger an immediate backup for a specific backup configuration. First UUID is the database, second is the specific backup configuration to trigger.
Parameters: (None)
Command: coolify database backup update <database_uuid> <backup_uuid>
Description: Update a backup configuration settings (frequency, retention, S3, etc.). First UUID is the database, second is the specific backup configuration.
Parameters:
- name: --databases-to-backup
type: string
description: Comma-separated list of databases to backup
required: false
- name: --dump-all
type: boolean
description: Dump all databases
required: false
default: false
- name: --enabled
type: boolean
description: Enable or disable backup
required: false
default: false
- name: --frequency
type: string
description: Backup frequency (cron expression)
required: false
- name: --retention-amount-locally
type: integer
description: Number of backups to retain locally
required: false
default: 0
- name: --retention-amount-s3
type: integer
description: Number of backups to retain in S3
required: false
default: 0
- name: --retention-days-locally
type: integer
description: Days to retain backups locally
required: false
default: 0
- name: --retention-days-s3
type: integer
description: Days to retain backups in S3
required: false
default: 0
- name: --retention-max-storage-locally
type: float64
description: Max storage for local backups (GB)
required: false
default: 0
- name: --retention-max-storage-s3
type: float64
description: Max storage for S3 backups (GB)
required: false
default: 0
- name: --s3-storage-uuid
type: string
description: S3 storage UUID
required: false
- name: --save-s3
type: boolean
description: Save backups to S3
required: false
default: false
Command: coolify database clone <uuid>
Description: Clone a database to a destination
Parameters:
- name: --clone-volumes
type: boolean
description: Clone volume data
required: false
default: false
- name: --destination
type: string
description: Destination UUID
required: false
- name: --name
type: string
description: Optional new name
required: false
Command: coolify database create <type>
Description: Create a new database
Parameters:
- name: --clickhouse-admin-password
type: string
description: Clickhouse admin password
required: false
- name: --clickhouse-admin-user
type: string
description: Clickhouse admin user
required: false
- name: --description
type: string
description: Database description
required: false
- name: --destination-uuid
type: string
description: Destination UUID if server has multiple destinations
required: false
- name: --dragonfly-password
type: string
description: Dragonfly password
required: false
- name: --environment-name
type: string
description: Environment name
required: false
- name: --environment-uuid
type: string
description: Environment UUID
required: false
- name: --image
type: string
description: Docker image
required: false
- name: --instant-deploy
type: boolean
description: Deploy immediately after creation
required: false
default: false
- name: --is-public
type: boolean
description: Make database publicly accessible
required: false
default: false
- name: --keydb-password
type: string
description: KeyDB password
required: false
- name: --limits-cpus
type: string
description: CPU limit (e.g., '0.5', '2')
required: false
- name: --limits-memory
type: string
description: Memory limit (e.g., '512m', '2g')
required: false
- name: --mariadb-database
type: string
description: MariaDB database name
required: false
- name: --mariadb-password
type: string
description: MariaDB password
required: false
- name: --mariadb-root-password
type: string
description: MariaDB root password
required: false
- name: --mariadb-user
type: string
description: MariaDB user
required: false
- name: --mongo-database
type: string
description: MongoDB database name
required: false
- name: --mongo-root-password
type: string
description: MongoDB root password
required: false
- name: --mongo-root-username
type: string
description: MongoDB root username
required: false
- name: --mysql-database
type: string
description: MySQL database name
required: false
- name: --mysql-password
type: string
description: MySQL password
required: false
- name: --mysql-root-password
type: string
description: MySQL root password
required: false
- name: --mysql-user
type: string
description: MySQL user
required: false
- name: --name
type: string
description: Database name
required: false
- name: --postgres-db
type: string
description: PostgreSQL database name
required: false
- name: --postgres-password
type: string
description: PostgreSQL password
required: false
- name: --postgres-user
type: string
description: PostgreSQL user
required: false
- name: --project-uuid
type: string
description: Project UUID (required)
required: true
- name: --public-port
type: integer
description: Public port
required: false
default: 0
- name: --redis-password
type: string
description: Redis password
required: false
- name: --server-uuid
type: string
description: Server UUID (required)
required: true
- name: --sqlite-databases
type: string
description: SQLite: comma-separated database file names (e.g. 'app.db,cache.db')
required: false
- name: --tag
type: stringArray
description: Tag to assign (repeatable)
required: false
- name: --tags
type: stringSlice
description: Comma-separated tags to assign
required: false
Command: coolify database delete <uuid>
Description: Delete a database and optionally clean up its configurations, volumes, and networks.
Parameters:
- name: --delete-configurations
type: boolean
description: Delete configurations
required: false
default: true
- name: --delete-connected-networks
type: boolean
description: Delete connected networks
required: false
default: true
- name: --delete-volumes
type: boolean
description: Delete volumes
required: false
default: true
- name: --docker-cleanup
type: boolean
description: Run docker cleanup
required: false
default: true
Command: coolify database env create <database_uuid>
Description: Create a new environment variable for a specific database. Use --key and --value flags to specify the variable.
Parameters:
- name: --comment
type: string
description: Comment for the environment variable
required: false
- name: --is-literal
type: boolean
description: Treat value as literal (don't interpolate variables)
required: false
default: false
- name: --is-multiline
type: boolean
description: Value is multiline
required: false
default: false
- name: --is-shown-once
type: boolean
description: Only show value once
required: false
default: false
- name: --key
type: string
description: Environment variable key (required)
required: true
- name: --value
type: string
description: Environment variable value (required)
required: true
Command: coolify database env delete <database_uuid> <env_uuid>
Description: Delete an environment variable from a database. First UUID is the database, second is the specific environment variable to delete.
Parameters:
- name: --force
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify database env get <database_uuid> <env_uuid_or_key>
Description: Get detailed information about a specific environment variable. First UUID is the database, second is the environment variable UUID or key name.
Parameters: (None)
Command: coolify database env list <database_uuid>
Description: List all environment variables for a specific database.
Parameters: (None)
Command: coolify database env sync <database_uuid>
Description: Sync environment variables from a .env file
Parameters:
- name: --file (-f)
type: string
description: Path to .env file (required)
required: true
- name: --is-literal
type: boolean
description: Treat all values as literal (don't interpolate variables)
required: false
default: false
Command: coolify database env update <database_uuid> <env_uuid_or_key>
Description: Update an existing environment variable. Identify it by UUID or key name.
Parameters:
- name: --comment
type: string
description: Comment for the environment variable
required: false
- name: --is-literal
type: boolean
description: Treat value as literal
required: false
default: false
- name: --is-multiline
type: boolean
description: Value is multiline
required: false
default: false
- name: --is-shown-once
type: boolean
description: Only show value once
required: false
default: false
- name: --key
type: string
description: New environment variable key (rename)
required: false
- name: --value
type: string
description: New environment variable value (required)
required: true
Command: coolify database get <uuid>
Description: Get detailed information about a specific database by UUID.
Parameters: (None)
Command: coolify database import start <database_uuid>
Description: Start an import into the database
Parameters:
- name: --dump-all
type: boolean
description: The backup contains all databases
required: false
default: false
- name: --file
type: string
description: Local backup file to upload and import
required: false
- name: --keep-owners
type: boolean
description: PostgreSQL: restore object owners and privileges from a single-database archive
required: false
default: false
- name: --poll-interval
type: duration
description: Status polling interval when --wait is set
required: false
default: 3s
- name: --replace-existing
type: boolean
description: PostgreSQL: drop matching objects before restoring a single-database archive
required: false
default: false
- name: --restore-mysql-users
type: boolean
description: MySQL/MariaDB all-databases backups: also restore users, passwords and privileges
required: false
default: false
- name: --s3-path
type: string
description: Path of the backup in the S3 storage
required: false
- name: --s3-storage-uuid
type: string
description: S3 storage UUID to import from (requires --s3-path)
required: false
- name: --server-path
type: string
description: Absolute path of the backup on the database's server
required: false
- name: --sqlite-database
type: string
description: SQLite: database file to restore into (e.g. app.db)
required: false
- name: --upload-id
type: string
description: ID of a previously uploaded backup file
required: false
- name: --wait
type: boolean
description: Wait until the import finishes; exits non-zero if it fails
required: false
default: false
Command: coolify database import status <database_uuid> <activity_id>
Description: Show the status of an import
Parameters:
- name: --poll-interval
type: duration
description: Status polling interval when --wait is set
required: false
default: 3s
- name: --wait
type: boolean
description: Wait until the import finishes; exits non-zero if it fails
required: false
default: false
Command: coolify database import upload <database_uuid> <file>
Description: Upload a local backup file (max 10 GiB) in chunks. Prints the upload ID to pass to 'start --upload-id'.
Parameters: (None)
Command: coolify database list
Description: List all databases in Coolify.
Parameters: (None)
Command: coolify database logs <uuid>
Description: Get database logs
Parameters:
- name: --lines (-n)
type: integer
description: Number of log lines to retrieve
required: false
default: 100
- name: --show-timestamps
type: boolean
description: Include timestamps in logs
required: false
default: false
Command: coolify database move <uuid>
Description: Move a database to another environment
Parameters:
- name: --environment-uuid
type: string
description: Target environment UUID (required)
required: true
Command: coolify database restart <uuid>
Description: Restart a database by UUID.
Parameters: (None)
Command: coolify database run-storage-backup <uuid> <storage_uuid>
Description: Run a volume backup schedule now
Parameters: (None)
Command: coolify database start <uuid>
Description: Start a database by UUID.
Parameters: (None)
Command: coolify database stop <uuid>
Description: Stop a database by UUID.
Parameters: (None)
Command: coolify database storage create <db_uuid>
Description: Create a storage for a database
Parameters:
- name: --content
type: string
description: File content (file only)
required: false
- name: --fs-path
type: string
description: Host directory path (file only, required when --is-directory is set)
required: false
- name: --host-path
type: string
description: Host path (persistent only)
required: false
- name: --is-directory
type: boolean
description: Whether this is a directory mount (file only)
required: false
default: false
- name: --mount-path
type: string
description: Mount path inside the container (required)
required: true
- name: --name
type: string
description: Volume name (persistent only)
required: false
- name: --type
type: string
description: Storage type: 'persistent' or 'file' (required)
required: true
Command: coolify database storage delete <db_uuid> <storage_uuid>
Description: Delete a storage from a database
Parameters: (None)
Command: coolify database storage delete-backup <db_uuid> <storage_uuid>
Description: Delete database storage volume backup schedule
Parameters: (None)
Command: coolify database storage list <db_uuid>
Description: List all persistent volumes and file storages for a specific database.
Parameters: (None)
Command: coolify database storage run-backup <db_uuid> <storage_uuid>
Description: Run database storage volume backup now
Parameters: (None)
Command: coolify database storage set-backup <db_uuid> <storage_uuid>
Description: Create or replace database storage volume backup schedule
Parameters:
- name: --disable-local-backup
type: boolean
description: Disable local backup retention
required: false
default: false
- name: --enabled
type: boolean
description: Enable the schedule
required: false
default: true
- name: --frequency
type: string
description: Cron frequency (required)
required: true
- name: --retention-amount-locally
type: integer
description: Local retention count
required: false
default: 7
- name: --retention-amount-s3
type: integer
description: S3 retention count
required: false
default: 7
- name: --retention-days-locally
type: integer
description: Local retention days
required: false
default: 0
- name: --retention-days-s3
type: integer
description: S3 retention days
required: false
default: 0
- name: --retention-max-storage-locally
type: float64
description: Local max storage
required: false
default: 0
- name: --retention-max-storage-s3
type: float64
description: S3 max storage
required: false
default: 0
- name: --s3-storage-uuid
type: string
description: S3 storage UUID when --save-s3 is set
required: false
- name: --save-s3
type: boolean
description: Also save backups to S3
required: false
default: false
- name: --stop-during-backup
type: boolean
description: Stop resource during backup
required: false
default: false
- name: --timeout
type: integer
description: Backup timeout seconds
required: false
default: 3600
Command: coolify database storage update <db_uuid>
Description: Update a storage for a database
Parameters:
- name: --content
type: string
description: File content (file only)
required: false
- name: --host-path
type: string
description: Host path (persistent only)
required: false
- name: --id
type: integer
description: Storage ID (deprecated, use --uuid instead)
required: false
default: 0
- name: --is-preview-suffix-enabled
type: boolean
description: Enable preview suffix for this storage
required: false
default: false
- name: --mount-path
type: string
description: Mount path inside the container
required: false
- name: --name
type: string
description: Storage name (persistent only)
required: false
- name: --type
type: string
description: Storage type: 'persistent' or 'file' (required)
required: true
- name: --uuid
type: string
description: Storage UUID (required, use 'storage list' to find)
required: false
Command: coolify database tag add <database-uuid> <name>
Description: Add a database tag
Parameters: (None)
Command: coolify database tag list <database-uuid>
Description: List database tags
Parameters: (None)
Command: coolify database tag remove <database-uuid> <tag-uuid>
Description: Remove a database tag
Parameters: (None)
Command: coolify database update <uuid>
Description: Update a database's configuration by UUID.
Parameters:
- name: --description
type: string
description: Database description
required: false
- name: --image
type: string
description: Docker image
required: false
- name: --is-public
type: boolean
description: Make database publicly accessible
required: false
default: false
- name: --limits-cpus
type: string
description: CPU limit
required: false
- name: --limits-memory
type: string
description: Memory limit
required: false
- name: --name
type: string
description: Database name
required: false
- name: --public-port
type: integer
description: Public port
required: false
default: 0
- name: --sqlite-databases
type: string
description: Comma-separated SQLite database file names (SQLite only)
required: false
Command: coolify deploy batch <name1,name2,...>
Description: Deploy multiple resources by name
Parameters:
- name: --docker-tag
type: string
description: Docker image tag override for the deployment
required: false
- name: --force
type: boolean
description: Force deployment
required: false
default: false
- name: --pull-request-id
type: integer
description: Pull request ID for preview deployments
required: false
default: 0
Command: coolify deploy cancel <uuid>
Description: Cancel an in-progress deployment. This will stop the deployment process and clean up any temporary resources.
Parameters:
- name: --force (-f)
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify deploy get <uuid>
Description: Get detailed information about a specific deployment by its UUID.
Parameters: (None)
Command: coolify deploy list
Description: List all currently running deployments across all resources.
Parameters: (None)
Command: coolify deploy name <resource_name>
Description: Deploy by resource name
Parameters:
- name: --docker-tag
type: string
description: Docker image tag override for the deployment
required: false
- name: --force
type: boolean
description: Force deployment
required: false
default: false
- name: --pull-request-id
type: integer
description: Pull request ID for preview deployments
required: false
default: 0
Command: coolify deploy uuid <uuid>
Description: Deploy by uuid
Parameters:
- name: --docker-tag
type: string
description: Docker image tag override for the deployment
required: false
- name: --force
type: boolean
description: Force deployment
required: false
default: false
- name: --pull-request-id
type: integer
description: Pull request ID for preview deployments
required: false
default: 0
Command: coolify destination create
Description: Create a destination for a server
Parameters:
- name: --name
type: string
description: Destination name (defaults on the server)
required: false
- name: --network
type: string
description: Docker network name (required)
required: true
- name: --server
type: string
description: Server UUID (required)
required: true
- name: --type
type: string
description: Destination type: standalone or swarm
required: false
Command: coolify destination delete <uuid>
Description: Delete an unused destination
Parameters: (None)
Command: coolify destination get <uuid>
Description: Get a destination
Parameters: (None)
Command: coolify destination list
Description: List destinations
Parameters:
- name: --server
type: string
description: Only destinations belonging to this server UUID
required: false
Command: coolify destination update <uuid>
Description: Rename a destination
Parameters:
- name: --name
type: string
description: New destination name
required: false
Command: coolify github branches <app_uuid> <owner/repo>
Description: List branches for a repository
Parameters: (None)
Command: coolify github create
Description: Create a GitHub App integration
Parameters:
- name: --api-url
type: string
description: GitHub API URL (derived from --html-url when omitted)
required: false
- name: --app-id
type: integer
description: GitHub App ID (required)
required: true
default: 0
- name: --client-id
type: string
description: GitHub OAuth Client ID (required)
required: true
- name: --client-secret
type: string
description: GitHub OAuth Client Secret (required)
required: true
- name: --custom-port
type: integer
description: Custom port for SSH (default: 22)
required: false
default: 0
- name: --custom-user
type: string
description: Custom user for SSH (default: git)
required: false
- name: --html-url
type: string
description: GitHub HTML URL (required, e.g., https://github.com)
required: true
- name: --installation-id
type: integer
description: GitHub Installation ID (required)
required: true
default: 0
- name: --name
type: string
description: GitHub App name (required)
required: true
- name: --organization
type: string
description: GitHub organization
required: false
- name: --private-key-uuid
type: string
description: UUID of existing private key (required)
required: true
- name: --system-wide
type: boolean
description: Is this app system-wide (cloud only)
required: false
default: false
- name: --webhook-secret
type: string
description: GitHub Webhook Secret
required: false
Command: coolify github delete <app_uuid>
Description: Delete a GitHub App integration. Accepts the app UUID (numeric ID also accepted). The app must not be used by any applications.
Parameters:
- name: --force (-f)
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify github get <app_uuid>
Description: Get detailed information about a specific GitHub App integration. Accepts the app UUID (numeric ID also accepted).
Parameters: (None)
Command: coolify github list
Description: List all GitHub App integrations configured in Coolify.
Parameters: (None)
Command: coolify github repos <app_uuid>
Description: List all repositories that are accessible by the specified GitHub App. Accepts the app UUID (numeric ID also accepted).
Parameters: (None)
Command: coolify github update <app_uuid>
Description: Update an existing GitHub App integration. Provide the app UUID (numeric ID also accepted) and the fields you want to update.
Parameters:
- name: --api-url
type: string
description: GitHub API URL
required: false
- name: --app-id
type: integer
description: GitHub App ID
required: false
default: 0
- name: --client-id
type: string
description: GitHub OAuth Client ID
required: false
- name: --client-secret
type: string
description: GitHub OAuth Client Secret
required: false
- name: --custom-port
type: integer
description: Custom port for SSH
required: false
default: 0
- name: --custom-user
type: string
description: Custom user for SSH
required: false
- name: --html-url
type: string
description: GitHub HTML URL
required: false
- name: --installation-id
type: integer
description: GitHub Installation ID
required: false
default: 0
- name: --name
type: string
description: GitHub App name
required: false
- name: --organization
type: string
description: GitHub organization
required: false
- name: --private-key-uuid
type: string
description: UUID of private key
required: false
- name: --system-wide
type: boolean
description: Is this app system-wide
required: false
default: false
- name: --webhook-secret
type: string
description: GitHub Webhook Secret
required: false
Command: coolify gitlab create
Description: Create a GitLab App integration
Parameters:
- name: --api-url
type: string
description: GitLab API URL (defaults to {html-url}/api/v4)
required: false
- name: --client-id
type: string
description: GitLab OAuth Application ID
required: false
- name: --client-secret
type: string
description: GitLab OAuth Application Secret
required: false
- name: --custom-port
type: integer
description: Custom SSH port (default: 22)
required: false
default: 0
- name: --custom-user
type: string
description: Custom SSH user (default: git)
required: false
- name: --group-name
type: string
description: Optional comma-separated group filter
required: false
- name: --html-url
type: string
description: GitLab instance URL (required, e.g. https://gitlab.com)
required: true
- name: --name
type: string
description: GitLab App name (required)
required: true
- name: --redirect-uri
type: string
description: OAuth redirect URI registered in GitLab
required: false
- name: --system-wide
type: boolean
description: Make this app system-wide (non-cloud instances only)
required: false
default: false
- name: --webhook-token
type: string
description: Webhook secret token (auto-generated when omitted)
required: false
Command: coolify gitlab delete <app_id_or_uuid>
Description: Delete a GitLab App integration. The app must not be used by any applications.
Parameters:
- name: --force (-f)
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify gitlab get <app_id_or_uuid>
Description: Get detailed information about a specific GitLab App integration.
Parameters: (None)
Command: coolify gitlab list
Description: List all GitLab App integrations configured in Coolify for the current team (includes system-wide sources).
Parameters: (None)
Command: coolify gitlab update <app_id_or_uuid>
Description: Update an existing GitLab App integration. Provide the app ID or UUID and the fields you want to update.
Parameters:
- name: --api-url
type: string
description: GitLab API URL
required: false
- name: --client-id
type: string
description: GitLab OAuth Application ID
required: false
- name: --client-secret
type: string
description: GitLab OAuth Application Secret
required: false
- name: --custom-port
type: integer
description: Custom SSH port
required: false
default: 0
- name: --custom-user
type: string
description: Custom SSH user
required: false
- name: --group-name
type: string
description: Optional comma-separated group filter
required: false
- name: --html-url
type: string
description: GitLab instance URL
required: false
- name: --name
type: string
description: GitLab App name
required: false
- name: --redirect-uri
type: string
description: OAuth redirect URI
required: false
- name: --system-wide
type: boolean
description: Is this app system-wide
required: false
default: false
- name: --webhook-token
type: string
description: Webhook secret token
required: false
Command: coolify integration-token create
Description: Create and validate a secret manager integration token
Parameters:
- name: --metadata
type: string
description: Provider metadata as a JSON object (required for infisical and vault)
required: false
- name: --name
type: string
description: Friendly token name (required)
required: true
- name: --provider
type: string
description: Secret manager provider: doppler, infisical, vault (required)
required: true
- name: --provider-token-stdin
type: boolean
description: Read the provider token from stdin
required: false
default: false
Command: coolify mcp disable
Description: Disable the Coolify MCP server (API: POST /mcp/disable). Requires a root team API token.
Parameters: (None)
Command: coolify mcp enable
Description: Enable the Coolify MCP server (API: POST /mcp/enable). Requires a root team API token.
Parameters: (None)
Command: coolify notification get <channel>
Description: Channels: email, discord, slack, telegram, pushover, webhook
Parameters: (None)
Command: coolify notification update <channel>
Description: Pass settings as JSON via --json. Example: coolify notification update webhook --json '{"webhook_enabled":true}'
Parameters:
- name: --json
type: string
description: JSON object of fields to update
required: false
Command: coolify private-key add <key_name> <private_key_or_file>
Description: Add a private key
Parameters:
- name: --description
type: string
description: Private key description
required: false
Command: coolify private-key get <uuid>
Description: Get a private key by UUID
Parameters: (None)
Command: coolify private-key list
Description: List all private keys
Parameters: (None)
Command: coolify private-key remove <uuid>
Description: Remove a private key
Parameters: (None)
Command: coolify private-key update <uuid>
Description: Update a private key
Parameters:
- name: --description
type: string
description: Private key description
required: false
- name: --name
type: string
description: Private key name
required: false
- name: --private-key
type: string
description: Private key content or path to key file (required)
required: true
Command: coolify project create
Description: Create a new project
Parameters:
- name: --description
type: string
description: Project description
required: false
- name: --name
type: string
description: Project name (required)
required: true
Command: coolify project delete <uuid>
Description: Delete a project
Parameters:
- name: --force (-f)
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify project environments create <project_uuid>
Description: Create an environment in a project
Parameters:
- name: --name
type: string
description: Environment name (required)
required: true
Command: coolify project environments delete <project_uuid> <environment>
Description: Delete a project environment
Parameters:
- name: --force (-f)
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify project environments get <project_uuid> <environment>
Description: Get an environment and its resources
Parameters: (None)
Command: coolify project environments list <project_uuid>
Description: List environments in a project
Parameters: (None)
Command: coolify project environments update <project_uuid> <environment>
Description: Update a project environment
Parameters:
- name: --description
type: string
description: Environment description
required: false
- name: --name
type: string
description: Environment name
required: false
Command: coolify project get <uuid>
Description: Get a project by uuid
Parameters: (None)
Command: coolify project list
Description: List all projects
Parameters: (None)
Command: coolify project update <uuid>
Description: Update a project
Parameters:
- name: --description
type: string
description: Project description
required: false
- name: --name
type: string
description: Project name
required: false
Command: coolify project update-environment <project_uuid> <environment>
Description: Update a project environment. Prefer: coolify project environments update
Parameters:
- name: --description
type: string
description: Environment description
required: false
- name: --name
type: string
description: Environment name
required: false
Command: coolify resource list
Description: List all resources
Parameters: (None)
Command: coolify s3 create
Description: Create an S3 storage
Parameters:
- name: --bucket
type: string
description: Bucket name
required: false
- name: --description
type: string
description: Description
required: false
- name: --endpoint
type: string
description: S3 endpoint URL
required: false
- name: --key
type: string
description: Access key
required: false
- name: --name
type: string
description: Storage name
required: false
- name: --region
type: string
description: Region
required: false
- name: --secret
type: string
description: Secret key
required: false
- name: --usable
type: boolean
description: Mark storage as usable
required: false
default: true
Command: coolify s3 delete <uuid>
Description: Delete an S3 storage
Parameters: (None)
Command: coolify s3 get <uuid>
Description: Get an S3 storage
Parameters: (None)
Command: coolify s3 list
Description: List S3 storages
Parameters: (None)
Command: coolify s3 update <uuid>
Description: Update an S3 storage
Parameters:
- name: --bucket
type: string
description: Bucket name
required: false
- name: --description
type: string
description: Description
required: false
- name: --endpoint
type: string
description: S3 endpoint URL
required: false
- name: --key
type: string
description: Access key
required: false
- name: --name
type: string
description: Storage name
required: false
- name: --region
type: string
description: Region
required: false
- name: --secret
type: string
description: Secret key
required: false
- name: --usable
type: boolean
description: Mark storage as usable
required: false
default: true
Command: coolify s3 validate <uuid>
Description: Validate S3 connection
Parameters: (None)
Command: coolify server add <server_name> <ip_address> <private_key_uuid>
Description: Add a server
Parameters:
- name: --port (-p)
type: integer
description: Port
required: false
default: 22
- name: --server-role
type: string
description: Server role (deployment|build|both): 'deployment' requires another usable build server
required: false
- name: --user (-u)
type: string
description: User
required: false
default: root
- name: --validate
type: boolean
description: Validate the server
required: false
default: false
Command: coolify server cloudflare-tunnel disable <server_uuid>
Description: Disable Cloudflare tunnel flag
Parameters: (None)
Command: coolify server cloudflare-tunnel enable <server_uuid>
Description: Enable Cloudflare tunnel flag
Parameters: (None)
Command: coolify server cloudflare-tunnel get <server_uuid>
Description: Get Cloudflare tunnel state
Parameters: (None)
Command: coolify server cloudflare-tunnel update <server_uuid>
Description: Set Cloudflare tunnel enabled state
Parameters:
- name: --enabled
type: boolean
description: Enable (true) or disable (false) Cloudflare tunnel
required: true
default: false
Command: coolify server destinations create <server_uuid>
Description: Create a server destination
Parameters:
- name: --name
type: string
description: Destination name
required: false
- name: --network
type: string
description: Docker network name (required)
required: true
- name: --type
type: string
description: Destination type: standalone or swarm
required: false
Command: coolify server destinations list <server_uuid>
Description: List server destinations
Parameters: (None)
Command: coolify server digitalocean create
Description: Create a DigitalOcean server
Parameters:
- name: --cloud-init
type: string
description: Cloud-init YAML
required: false
- name: --cloud-token
type: string
description: Cloud provider token UUID
required: false
- name: --enable-ipv6
type: boolean
description: Enable public IPv6
required: false
default: true
- name: --image
type: string
description: DigitalOcean image ID or slug
required: false
- name: --monitoring
type: boolean
description: Enable DigitalOcean monitoring
required: false
default: true
- name: --name
type: string
description: Server name
required: false
- name: --private-key
type: string
description: Coolify private key UUID
required: false
- name: --region
type: string
description: DigitalOcean region
required: false
- name: --size
type: string
description: DigitalOcean size
required: false
- name: --ssh-key-ids
type: intSlice
description: Additional DigitalOcean SSH key IDs
required: false
- name: --validate
type: boolean
description: Validate after creation
required: false
default: false
Command: coolify server digitalocean images <cloud_token_uuid>
Description: List DigitalOcean images
Parameters: (None)
Command: coolify server digitalocean regions <cloud_token_uuid>
Description: List DigitalOcean regions
Parameters: (None)
Command: coolify server digitalocean sizes <cloud_token_uuid>
Description: List DigitalOcean sizes
Parameters: (None)
Command: coolify server digitalocean ssh-keys <cloud_token_uuid>
Description: List DigitalOcean SSH keys
Parameters: (None)
Command: coolify server docker-cleanup executions <server_uuid>
Description: List docker cleanup executions
Parameters: (None)
Command: coolify server docker-cleanup get <server_uuid>
Description: Get docker cleanup settings
Parameters: (None)
Command: coolify server docker-cleanup run <server_uuid>
Description: Run docker cleanup now
Parameters: (None)
Command: coolify server docker-cleanup update <server_uuid>
Description: Update docker cleanup settings
Parameters:
- name: --delete-unused-networks
type: boolean
description: Delete unused networks
required: false
default: false
- name: --delete-unused-volumes
type: boolean
description: Delete unused volumes
required: false
default: false
- name: --disable-image-retention
type: boolean
description: Disable application image retention
required: false
default: false
- name: --force
type: boolean
description: Force cleanup
required: false
default: false
- name: --frequency
type: string
description: Cron frequency
required: false
- name: --threshold
type: integer
description: Disk usage threshold percent
required: false
default: 0
Command: coolify server domains <uuid>
Description: Get server domains by uuid
Parameters: (None)
Command: coolify server get <uuid>
Description: Get server details by uuid
Parameters:
- name: --resources
type: boolean
description: Show the resources deployed on the server instead of the server details
required: false
default: false
Command: coolify server hetzner create
Description: Create a Hetzner server
Parameters:
- name: --cloud-init
type: string
description: Cloud-init YAML
required: false
- name: --cloud-token
type: string
description: Cloud provider token UUID
required: false
- name: --enable-backups
type: boolean
description: Enable Hetzner backups
required: false
default: false
- name: --enable-ipv4
type: boolean
description: Enable public IPv4
required: false
default: true
- name: --enable-ipv6
type: boolean
description: Enable public IPv6
required: false
default: true
- name: --firewall-ids
type: intSlice
description: Hetzner firewall IDs
required: false
- name: --image
type: integer
description: Hetzner image ID
required: false
default: 0
- name: --location
type: string
description: Hetzner location name
required: false
- name: --name
type: string
description: Server name (auto-generated if omitted)
required: false
- name: --network-ids
type: intSlice
description: Hetzner network IDs
required: false
- name: --private-key
type: string
description: Coolify private key UUID
required: false
- name: --server-type
type: string
description: Hetzner server type
required: false
- name: --ssh-key-ids
type: intSlice
description: Additional Hetzner SSH key IDs
required: false
- name: --validate
type: boolean
description: Validate after creation
required: false
default: false
Command: coolify server hetzner firewalls <cloud_token_uuid>
Description: List Hetzner firewalls
Parameters: (None)
Command: coolify server hetzner images <cloud_token_uuid>
Description: List Hetzner images
Parameters: (None)
Command: coolify server hetzner locations <cloud_token_uuid>
Description: List Hetzner locations
Parameters: (None)
Command: coolify server hetzner networks <cloud_token_uuid>
Description: List Hetzner networks
Parameters: (None)
Command: coolify server hetzner server-types <cloud_token_uuid>
Description: List Hetzner server types
Parameters: (None)
Command: coolify server hetzner ssh-keys <cloud_token_uuid>
Description: List Hetzner SSH keys
Parameters: (None)
Command: coolify server list
Description: List all servers
Parameters: (None)
Command: coolify server log-drains get <server_uuid>
Description: Get log drain settings
Parameters: (None)
Command: coolify server log-drains update <server_uuid>
Description: Update log drain settings via JSON
Parameters:
- name: --json
type: string
description: JSON fields to patch
required: false
Command: coolify server proxy get <server_uuid>
Description: Get proxy settings
Parameters: (None)
Command: coolify server proxy restart <server_uuid>
Description: Restart proxy
Parameters: (None)
Command: coolify server proxy set-config <server_uuid>
Description: Save raw proxy configuration
Parameters:
- name: --configuration
type: string
description: Raw proxy configuration
required: false
- name: --configuration-file
type: string
description: Read configuration from file
required: false
Command: coolify server proxy update <server_uuid>
Description: Update proxy settings
Parameters:
- name: --generate-exact-labels
type: boolean
description: Generate exact labels
required: false
default: false
- name: --proxy-type
type: string
description: Proxy type (e.g. TRAEFIK)
required: false
- name: --redirect-enabled
type: boolean
description: Enable proxy redirect
required: false
default: true
- name: --redirect-url
type: string
description: Redirect URL
required: false
Command: coolify server registry check <server_uuid> <registry>
Description: Check that the saved registry login of a server still works
Parameters: (None)
Command: coolify server registry list <server_uuid>
Description: List registry logins of a server
Parameters: (None)
Command: coolify server registry login <server_uuid> [<server_uuid>...]
Description: Log in to a Docker registry on one or more servers
Parameters:
- name: --password-stdin
type: boolean
description: Read the password or access token from stdin
required: false
default: false
- name: --registry
type: string
description: Registry host, optionally with a port (e.g. ghcr.io, registry.example.com:5000, docker.io for Docker Hub) (required)
required: true
- name: --username (-u)
type: string
description: Registry username (required)
required: true
Command: coolify server registry logout <server_uuid> <registry>
Description: Log out from a Docker registry on a server
Parameters:
- name: --force (-f)
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify server remove <uuid>
Description: Remove a server
Parameters:
- name: --delete-from-provider
type: boolean
description: Also delete the server from its cloud provider (Hetzner, Vultr or DigitalOcean). This cannot be undone
required: false
default: false
- name: --force
type: boolean
description: Also delete all resources on the server
required: false
default: false
Command: coolify server sentinel get <server_uuid>
Description: Get Sentinel settings
Parameters: (None)
Command: coolify server sentinel update <server_uuid>
Description: Update Sentinel settings via JSON
Parameters:
- name: --json
type: string
description: JSON fields to patch
required: false
Command: coolify server update <uuid>
Description: Update a server
Parameters:
- name: --concurrent-builds
type: integer
description: Max concurrent builds
required: false
default: 0
- name: --connection-timeout
type: integer
description: SSH connection timeout in seconds
required: false
default: 0
- name: --deployment-queue-limit
type: integer
description: Deployment queue limit
required: false
default: 0
- name: --description
type: string
description: Server description
required: false
- name: --disk-usage-check-frequency
type: string
description: Disk usage check frequency (cron)
required: false
- name: --disk-usage-notification-threshold
type: integer
description: Disk usage notification threshold percent
required: false
default: 0
- name: --dynamic-timeout
type: integer
description: Dynamic timeout
required: false
default: 0
- name: --instant-validate
type: boolean
description: Validate server after update
required: false
default: false
- name: --ip
type: string
description: Server IP address
required: false
- name: --is-build-server
type: boolean
description: Deprecated: use --server-role build (true) or --server-role both (false)
required: false
default: false
- name: --is-terminal-enabled
type: boolean
description: Enable terminal access
required: false
default: false
- name: --name
type: string
description: Server name
required: false
- name: --port
type: integer
description: SSH port
required: false
default: 22
- name: --private-key-uuid
type: string
description: Private key UUID
required: false
- name: --proxy-type
type: string
description: Proxy type (e.g. TRAEFIK, CADDY, NGINX)
required: false
- name: --server-role
type: string
description: Server role (deployment|build|both): 'deployment' requires another usable build server
required: false
- name: --user
type: string
description: SSH user
required: false
Command: coolify server validate <uuid>
Description: Validate a server
Parameters:
- name: --install
type: boolean
description: Install missing prerequisites and Docker (may restart Docker)
required: false
default: false
Command: coolify server vultr create
Description: Create a Vultr server
Parameters:
- name: --cloud-init
type: string
description: Cloud-init YAML
required: false
- name: --cloud-token
type: string
description: Cloud provider token UUID
required: false
- name: --disable-public-ipv4
type: boolean
description: Disable public IPv4
required: false
default: false
- name: --enable-ipv6
type: boolean
description: Enable public IPv6
required: false
default: true
- name: --name
type: string
description: Server name
required: false
- name: --os-id
type: integer
description: Vultr operating system ID
required: false
default: 0
- name: --plan
type: string
description: Vultr plan
required: false
- name: --private-key
type: string
description: Coolify private key UUID
required: false
- name: --region
type: string
description: Vultr region
required: false
- name: --ssh-key-ids
type: stringSlice
description: Additional Vultr SSH key IDs
required: false
- name: --validate
type: boolean
description: Validate after creation
required: false
default: false
Command: coolify server vultr os <cloud_token_uuid>
Description: List Vultr operating systems
Parameters: (None)
Command: coolify server vultr plans <cloud_token_uuid>
Description: List Vultr plans
Parameters: (None)
Command: coolify server vultr regions <cloud_token_uuid>
Description: List Vultr regions
Parameters: (None)
Command: coolify server vultr ssh-keys <cloud_token_uuid>
Description: List Vultr SSH keys
Parameters: (None)
Command: coolify service application get <service-uuid> <application-uuid>
Description: Get an application in a service
Parameters: (None)
Command: coolify service application list <service-uuid>
Description: List applications in a service
Parameters: (None)
Command: coolify service application logs <service-uuid> <application-uuid>
Description: Get logs for an application in a service
Parameters:
- name: --lines (-n)
type: integer
description: Number of log lines to retrieve
required: false
default: 100
Command: coolify service application restart <service-uuid> <application-uuid>
Description: Restart an application in a service
Parameters: (None)
Command: coolify service application start <service-uuid> <application-uuid>
Description: Start or redeploy an application in a service
Parameters:
- name: --force
type: boolean
description: Rebuild the application
required: false
default: false
- name: --latest
type: boolean
description: Pull the latest image
required: false
default: false
Command: coolify service application stop <service-uuid> <application-uuid>
Description: Stop an application in a service
Parameters: (None)
Command: coolify service application update <service-uuid> <application-uuid>
Description: Update an application in a service
Parameters:
- name: --description
type: string
description: Description
required: false
- name: --exclude-from-status
type: boolean
description: Exclude from service status
required: false
default: false
- name: --force-domain-override
type: boolean
description: Allow conflicting or duplicate domains
required: false
default: false
- name: --gzip-enabled
type: boolean
description: Enable gzip compression
required: false
default: false
- name: --human-name
type: string
description: Human-readable name
required: false
- name: --image
type: string
description: Container image
required: false
- name: --log-drain-enabled
type: boolean
description: Enable log drain
required: false
default: false
- name: --stripprefix-enabled
type: boolean
description: Enable path prefix stripping
required: false
default: false
- name: --url
type: string
description: Comma-separated public URLs
required: false
Command: coolify service clone <uuid>
Description: Clone a service to a destination
Parameters:
- name: --clone-volumes
type: boolean
description: Clone volume data
required: false
default: false
- name: --destination
type: string
description: Destination UUID
required: false
- name: --name
type: string
description: Optional new name
required: false
Command: coolify service create <type>
Description: Create a new one-click service
Parameters:
- name: --description
type: string
description: Service description
required: false
- name: --destination-uuid
type: string
description: Destination UUID if server has multiple destinations
required: false
- name: --docker-compose
type: string
description: Custom Docker Compose content (for advanced customization)
required: false
- name: --environment-name
type: string
description: Environment name
required: false
- name: --environment-uuid
type: string
description: Environment UUID
required: false
- name: --instant-deploy
type: boolean
description: Deploy immediately after creation
required: false
default: false
- name: --list-types
type: boolean
description: List all available service types
required: false
default: false
- name: --name
type: string
description: Service name
required: false
- name: --project-uuid
type: string
description: Project UUID (required)
required: true
- name: --server-uuid
type: string
description: Server UUID (required)
required: true
- name: --tag
type: stringArray
description: Tag to assign (repeatable)
required: false
- name: --tags
type: stringSlice
description: Comma-separated tags to assign
required: false
Command: coolify service database get <service-uuid> <database-uuid>
Description: Get a database in a service
Parameters: (None)
Command: coolify service database import start <service_uuid> <database_uuid>
Description: Start an import into the database
Parameters:
- name: --dump-all
type: boolean
description: The backup contains all databases
required: false
default: false
- name: --file
type: string
description: Local backup file to upload and import
required: false
- name: --keep-owners
type: boolean
description: PostgreSQL: restore object owners and privileges from a single-database archive
required: false
default: false
- name: --poll-interval
type: duration
description: Status polling interval when --wait is set
required: false
default: 3s
- name: --replace-existing
type: boolean
description: PostgreSQL: drop matching objects before restoring a single-database archive
required: false
default: false
- name: --restore-mysql-users
type: boolean
description: MySQL/MariaDB all-databases backups: also restore users, passwords and privileges
required: false
default: false
- name: --s3-path
type: string
description: Path of the backup in the S3 storage
required: false
- name: --s3-storage-uuid
type: string
description: S3 storage UUID to import from (requires --s3-path)
required: false
- name: --server-path
type: string
description: Absolute path of the backup on the database's server
required: false
- name: --sqlite-database
type: string
description: SQLite: database file to restore into (e.g. app.db)
required: false
- name: --upload-id
type: string
description: ID of a previously uploaded backup file
required: false
- name: --wait
type: boolean
description: Wait until the import finishes; exits non-zero if it fails
required: false
default: false
Command: coolify service database import status <service_uuid> <database_uuid> <activity_id>
Description: Show the status of an import
Parameters:
- name: --poll-interval
type: duration
description: Status polling interval when --wait is set
required: false
default: 3s
- name: --wait
type: boolean
description: Wait until the import finishes; exits non-zero if it fails
required: false
default: false
Command: coolify service database import upload <service_uuid> <database_uuid> <file>
Description: Upload a local backup file (max 10 GiB) in chunks. Prints the upload ID to pass to 'start --upload-id'.
Parameters: (None)
Command: coolify service database list <service-uuid>
Description: List databases in a service
Parameters: (None)
Command: coolify service database logs <service-uuid> <database-uuid>
Description: Get logs for a database in a service
Parameters:
- name: --lines (-n)
type: integer
description: Number of log lines to retrieve
required: false
default: 100
Command: coolify service database restart <service-uuid> <database-uuid>
Description: Restart a database in a service
Parameters: (None)
Command: coolify service database start <service-uuid> <database-uuid>
Description: Start or redeploy a database in a service
Parameters:
- name: --force
type: boolean
description: Rebuild the database container
required: false
default: false
- name: --latest
type: boolean
description: Pull the latest image
required: false
default: false
Command: coolify service database stop <service-uuid> <database-uuid>
Description: Stop a database in a service
Parameters: (None)
Command: coolify service database update <service-uuid> <database-uuid>
Description: Update a database in a service
Parameters:
- name: --description
type: string
description: Description
required: false
- name: --exclude-from-status
type: boolean
description: Exclude from service status
required: false
default: false
- name: --human-name
type: string
description: Human-readable name
required: false
- name: --image
type: string
description: Container image
required: false
- name: --log-drain-enabled
type: boolean
description: Enable log drain
required: false
default: false
- name: --public
type: boolean
description: Expose the database publicly
required: false
default: false
- name: --public-port
type: integer
description: Public database port
required: false
default: 0
- name: --public-port-timeout
type: integer
description: Public proxy timeout in seconds
required: false
default: 0
Command: coolify service delete <uuid>
Description: Delete a service and optionally clean up its configurations, volumes, and networks.
Parameters:
- name: --delete-configurations
type: boolean
description: Delete configurations
required: false
default: true
- name: --delete-connected-networks
type: boolean
description: Delete connected networks
required: false
default: true
- name: --delete-volumes
type: boolean
description: Delete volumes
required: false
default: true
- name: --docker-cleanup
type: boolean
description: Run docker cleanup
required: false
default: true
- name: --force (-f)
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify service env create <service_uuid>
Description: Create a new environment variable for a specific service. Use --key and --value flags to specify the variable.
Parameters:
- name: --build-time
type: boolean
description: Available at build time (default: true)
required: false
default: true
- name: --comment
type: string
description: Comment for the environment variable
required: false
- name: --is-literal
type: boolean
description: Treat value as literal (don't interpolate variables)
required: false
default: false
- name: --is-multiline
type: boolean
description: Value is multiline
required: false
default: false
- name: --key
type: string
description: Environment variable key (required)
required: true
- name: --runtime
type: boolean
description: Available at runtime (default: true)
required: false
default: true
- name: --value
type: string
description: Environment variable value (required)
required: true
Command: coolify service env delete <service_uuid> <env_uuid>
Description: Delete an environment variable from a service. First UUID is the service, second is the specific environment variable to delete.
Parameters:
- name: --force
type: boolean
description: Skip confirmation prompt
required: false
default: false
Command: coolify service env get <service_uuid> <env_uuid_or_key>
Description: Get detailed information about a specific environment variable. First UUID is the service, second is the environment variable UUID or key name.
Parameters: (None)
Command: coolify service env list <service_uuid>
Description: List all environment variables for a specific service.
Parameters: (None)
Command: coolify service env sync <service_uuid>
Description: Sync environment variables from a .env file
Parameters:
- name: --build-time
type: boolean
description: Make all variables available at build time (default: true)
required: false
default: true
- name: --file (-f)
type: string
description: Path to .env file (required)
required: true
- name: --is-literal
type: boolean
description: Treat all values as literal (don't interpolate variables)
required: false
default: false
- name: --runtime
type: boolean
description: Make all variables available at runtime (default: true)
required: false
default: true
Command: coolify service env update <service_uuid> <env_uuid_or_key>
Description: Update an existing environment variable. Identify it by UUID or key name.
Parameters:
- name: --build-time
type: boolean
description: Available at build time (default: true)
required: false
default: true
- name: --comment
type: string
description: Comment for the environment variable
required: false
- name: --is-literal
type: boolean
description: Treat value as literal (don't interpolate variables)
required: false
default: false
- name: --is-multiline
type: boolean
description: Value is multiline
required: false
default: false
- name: --key
type: string
description: New environment variable key (rename)
required: false
- name: --runtime
type: boolean
description: Available at runtime (default: true)
required: false
default: true
- name: --value
type: string
description: New environment variable value (required)
required: true
Command: coolify service execute-task <service_uuid> <task_uuid>
Description: Execute a service scheduled task now
Parameters: (None)
Command: coolify service get <uuid>
Description: Get detailed information about a specific service.
Parameters: (None)
Command: coolify service list
Description: List all services in Coolify.
Parameters: (None)
Command: coolify service logs <uuid>
Description: Get logs for a service sub-resource
Parameters:
- name: --lines (-n)
type: integer
description: Number of log lines to retrieve
required: false
default: 100
- name: --show-timestamps
type: boolean
description: Include timestamps in logs
required: false
default: false
- name: --sub-service-name
type: string
description: Sub-service name from the service applications or databases list (required)
required: true
Command: coolify service move <uuid>
Description: Move a service to another environment
Parameters:
- name: --environment-uuid
type: string
description: Target environment UUID (required)
required: true
Command: coolify service restart <uuid>
Description: Restart a service (restart all containers).
Parameters: (None)
Command: coolify service run-storage-backup <uuid> <storage_uuid>
Description: Run a service volume backup schedule now
Parameters: (None)
Command: coolify service start <uuid>
Description: Start a service (deploy all containers).
Parameters: (None)
Command: coolify service stop <uuid>
Description: Stop a service (stop all containers).
Parameters: (None)
Command: coolify service storage create <service_uuid>
Description: Create a storage for a service
Parameters:
- name: --content
type: string
description: File content (file only)
required: false
- name: --fs-path
type: string
description: Host directory path (file only, required when --is-directory is set)
required: false
- name: --host-path
type: string
description: Host path (persistent only)
required: false
- name: --is-directory
type: boolean
description: Whether this is a directory mount (file only)
required: false
default: false
- name: --mount-path
type: string
description: Mount path inside the container (required)
required: true
- name: --name
type: string
description: Volume name (persistent only)
required: false
- name: --resource-uuid
type: string
description: UUID of the service sub-resource (required)
required: true
- name: --type
type: string
description: Storage type: 'persistent' or 'file' (required)
required: true
Command: coolify service storage delete <service_uuid> <storage_uuid>
Description: Delete a storage from a service
Parameters: (None)
Command: coolify service storage delete-backup <service_uuid> <storage_uuid>
Description: Delete service storage volume backup schedule
Parameters: (None)
Command: coolify service storage list <service_uuid>
Description: List all persistent volumes and file storages for a specific service.
Parameters: (None)
Command: coolify service storage run-backup <service_uuid> <storage_uuid>
Description: Run service storage volume backup now
Parameters: (None)
Command: coolify service storage set-backup <service_uuid> <storage_uuid>
Description: Create or replace service storage volume backup schedule
Parameters:
- name: --disable-local-backup
type: boolean
description: Disable local backup retention
required: false
default: false
- name: --enabled
type: boolean
description: Enable the schedule
required: false
default: true
- name: --frequency
type: string
description: Cron frequency (required)
required: true
- name: --retention-amount-locally
type: integer
description: Local retention count
required: false
default: 7
- name: --retention-amount-s3
type: integer
description: S3 retention count
required: false
default: 7
- name: --retention-days-locally
type: integer
description: Local retention days
required: false
default: 0
- name: --retention-days-s3
type: integer
description: S3 retention days
required: false
default: 0
- name: --retention-max-storage-locally
type: float64
description: Local max storage
required: false
default: 0
- name: --retention-max-storage-s3
type: float64
description: S3 max storage
required: false
default: 0
- name: --s3-storage-uuid
type: string
description: S3 storage UUID when --save-s3 is set
required: false
- name: --save-s3
type: boolean
description: Also save backups to S3
required: false
default: false
- name: --stop-during-backup
type: boolean
description: Stop resource during backup
required: false
default: false
- name: --timeout
type: integer
description: Backup timeout seconds
required: false
default: 3600
Command: coolify service storage update <service_uuid>
Description: Update a storage for a service
Parameters:
- name: --content
type: string
description: File content (file only)
required: false
- name: --host-path
type: string
description: Host path (persistent only)
required: false
- name: --id
type: integer
description: Storage ID (deprecated, use --uuid instead)
required: false
default: 0
- name: --is-preview-suffix-enabled
type: boolean
description: Enable preview suffix for this storage
required: false
default: false
- name: --mount-path
type: string
description: Mount path inside the container
required: false
- name: --name
type: string
description: Storage name (persistent only)
required: false
- name: --type
type: string
description: Storage type: 'persistent' or 'file' (required)
required: true
- name: --uuid
type: string
description: Storage UUID (required, use 'storage list' to find)
required: false
Command: coolify service tag add <service-uuid> <name>
Description: Add a service tag
Parameters: (None)
Command: coolify service tag list <service-uuid>
Description: List service tags
Parameters: (None)
Command: coolify service tag remove <service-uuid> <tag-uuid>
Description: Remove a service tag
Parameters: (None)
Command: coolify service task create <service_uuid>
Description: Create a scheduled task for a service
Parameters:
- name: --command
type: string
description: Command to run (required)
required: true
- name: --container
type: string
description: Container name to run the command in
required: false
- name: --enabled
type: boolean
description: Whether the task is enabled
required: false
default: true
- name: --frequency
type: string
description: Cron expression or frequency (required)
required: true
- name: --name
type: string
description: Task name (required)
required: true
- name: --timeout
type: integer
description: Timeout in seconds
required: false
default: 300
Command: coolify service task delete <service_uuid> <task_uuid>
Description: Delete a service scheduled task
Parameters: (None)
Command: coolify service task execute <service_uuid> <task_uuid>
Description: Execute a service scheduled task now
Parameters: (None)
Command: coolify service task executions <service_uuid> <task_uuid>
Description: List executions for a service scheduled task
Parameters: (None)
Command: coolify service task list <service_uuid>
Description: List scheduled tasks for a service
Parameters: (None)
Command: coolify service task update <service_uuid> <task_uuid>
Description: Update a service scheduled task
Parameters:
- name: --command
type: string
description: Command to run
required: false
- name: --container
type: string
description: Container name to run the command in
required: false
- name: --enabled
type: boolean
description: Whether the task is enabled
required: false
default: true
- name: --frequency
type: string
description: Cron expression or frequency
required: false
- name: --name
type: string
description: Task name
required: false
- name: --timeout
type: integer
description: Timeout in seconds
required: false
default: 300
Command: coolify settings email get
Description: Get instance email settings
Parameters: (None)
Command: coolify settings email update
Description: Pass settings as JSON via --json. Requires write:sensitive. Example: coolify settings email update --json '{"smtp_ehlo_domain":"coolify.example.com"}'
Parameters:
- name: --json
type: string
description: JSON object of fields to update
required: false
Command: coolify shared-env environment create <project_uuid> <environment>
Description: Create environment shared env
Parameters:
- name: --comment
type: string
description: Comment
required: false
- name: --key
type: string
description: Variable key
required: false
- name: --literal
type: boolean
description: Treat value as literal
required: false
default: false
- name: --multiline
type: boolean
description: Multiline value
required: false
default: false
- name: --shown-once
type: boolean
description: Show value only once
required: false
default: false
- name: --value
type: string
description: Variable value
required: false
Command: coolify shared-env environment delete <project_uuid> <environment> <id>
Description: Delete environment shared env
Parameters: (None)
Command: coolify shared-env environment list <project_uuid> <environment>
Description: List environment shared envs
Parameters: (None)
Command: coolify shared-env environment update <project_uuid> <environment> <id>
Description: Update environment shared env
Parameters:
- name: --comment
type: string
description: Comment
required: false
- name: --key
type: string
description: Variable key
required: false
- name: --literal
type: boolean
description: Treat value as literal
required: false
default: false
- name: --multiline
type: boolean
description: Multiline value
required: false
default: false
- name: --shown-once
type: boolean
description: Show value only once
required: false
default: false
- name: --value
type: string
description: Variable value
required: false
Command: coolify shared-env project create <project_uuid>
Description: Create project shared env
Parameters:
- name: --comment
type: string
description: Comment
required: false
- name: --key
type: string
description: Variable key
required: false
- name: --literal
type: boolean
description: Treat value as literal
required: false
default: false
- name: --multiline
type: boolean
description: Multiline value
required: false
default: false
- name: --shown-once
type: boolean
description: Show value only once
required: false
default: false
- name: --value
type: string
description: Variable value
required: false
Command: coolify shared-env project delete <project_uuid> <id>
Description: Delete project shared env
Parameters: (None)
Command: coolify shared-env project list <project_uuid>
Description: List project shared envs
Parameters: (None)
Command: coolify shared-env project update <project_uuid> <id>
Description: Update project shared env
Parameters:
- name: --comment
type: string
description: Comment
required: false
- name: --key
type: string
description: Variable key
required: false
- name: --literal
type: boolean
description: Treat value as literal
required: false
default: false
- name: --multiline
type: boolean
description: Multiline value
required: false
default: false
- name: --shown-once
type: boolean
description: Show value only once
required: false
default: false
- name: --value
type: string
description: Variable value
required: false
Command: coolify shared-env server create <server_uuid>
Description: Create server shared env
Parameters:
- name: --comment
type: string
description: Comment
required: false
- name: --key
type: string
description: Variable key
required: false
- name: --literal
type: boolean
description: Treat value as literal
required: false
default: false
- name: --multiline
type: boolean
description: Multiline value
required: false
default: false
- name: --shown-once
type: boolean
description: Show value only once
required: false
default: false
- name: --value
type: string
description: Variable value
required: false
Command: coolify shared-env server delete <server_uuid> <id>
Description: Delete server shared env
Parameters: (None)
Command: coolify shared-env server list <server_uuid>
Description: List server shared envs
Parameters: (None)
Command: coolify shared-env server update <server_uuid> <id>
Description: Update server shared env
Parameters:
- name: --comment
type: string
description: Comment
required: false
- name: --key
type: string
description: Variable key
required: false
- name: --literal
type: boolean
description: Treat value as literal
required: false
default: false
- name: --multiline
type: boolean
description: Multiline value
required: false
default: false
- name: --shown-once
type: boolean
description: Show value only once
required: false
default: false
- name: --value
type: string
description: Variable value
required: false
Command: coolify shared-env team create
Description: Create team shared env
Parameters:
- name: --comment
type: string
description: Comment
required: false
- name: --key
type: string
description: Variable key
required: false
- name: --literal
type: boolean
description: Treat value as literal
required: false
default: false
- name: --multiline
type: boolean
description: Multiline value
required: false
default: false
- name: --shown-once
type: boolean
description: Show value only once
required: false
default: false
- name: --value
type: string
description: Variable value
required: false
Command: coolify shared-env team delete <id>
Description: Delete team shared env
Parameters: (None)
Command: coolify shared-env team list
Description: List team shared envs
Parameters: (None)
Command: coolify shared-env team update <id>
Description: Update team shared env
Parameters:
- name: --comment
type: string
description: Comment
required: false
- name: --key
type: string
description: Variable key
required: false
- name: --literal
type: boolean
description: Treat value as literal
required: false
default: false
- name: --multiline
type: boolean
description: Multiline value
required: false
default: false
- name: --shown-once
type: boolean
description: Show value only once
required: false
default: false
- name: --value
type: string
description: Variable value
required: false
Command: coolify tag create
Description: Create a team tag
Parameters:
- name: --name
type: string
description: Tag name
required: false
Command: coolify tag delete <uuid>
Description: Delete a team tag
Parameters: (None)
Command: coolify tag list
Description: List all team tags
Parameters: (None)
Command: coolify tag update <uuid>
Description: Rename a team tag
Parameters:
- name: --name
type: string
description: New tag name
required: false
Command: coolify teams current
Description: Get details of the team associated with the authentication token (API: GET /team).
Parameters: (None)
Command: coolify teams get <team_id>
Description: Get detailed information about a specific team by its ID.
Parameters: (None)
Command: coolify teams list
Description: List all teams you have access to.
Parameters: (None)
Command: coolify teams members list [team_id]
Description: List members of a specific team by ID, or list members of the current team if no ID is provided.
Parameters: (None)
Command: coolify teams update
Description: Update settings of the team bound to the API token
Parameters:
- name: --build-server-fallback
type: boolean
description: Allow deployments to fall back to the deployment server when no build server is usable (required)
required: true
default: false
Command: coolify update
Description: Update Coolify CLI
Parameters: (None)
Command: coolify version
Description: Current Coolify CLI version
Parameters: (None)
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.