coolify-cli/llms.txt at v4.x · coollabsio/coolify-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# Coolify CLI - llms.txt

> Quick AI/LLM instructions for the Coolify CLI.
> Source: https://github.com/coollabsio/coolify-cli
> API Spec: https://github.com/coollabsio/coolify/blob/v4.x/openapi.json

## Operating Rules

- Prefer `--format json` for automation and parsing.
- Use Coolify UUIDs for resources; do not use internal numeric IDs.
- Team commands are the exception: they use numeric team IDs.
- Authenticate with a saved context when possible; use `--token` only for overrides.
- Use `llms-full.txt` for the exhaustive command/flag catalog.

## 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>`
4. Switch contexts with `coolify context use <context_name>`

## 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

## Global Flags

- `--context <name>` - use a specific saved context
- `--token <token>` - override token from config
- `--format table|json|pretty` - choose output format
- `--show-sensitive` - reveal sensitive values
- `--debug` - enable debug output

## Common Workflows

### Contexts

```bash
coolify context list
coolify context verify
coolify context version
coolify context use prod
```

### Inventory

```bash
coolify server list
coolify project list
coolify resource list
coolify app list
coolify service list
coolify database list
```

### Applications

```bash
coolify app get <uuid>
coolify app start <uuid>
coolify app stop <uuid>
coolify app restart <uuid>
coolify app logs <uuid> --follow
coolify app deployments list <app-uuid>
coolify app deployments logs <app-uuid> --follow
```

### Environment Variables

```bash
coolify app env list <app-uuid>
coolify app env create <app-uuid> --key API_KEY --value secret123
coolify app env update <app-uuid> <env-uuid-or-key> --value new-secret
coolify app env sync <app-uuid> --file .env.production --build-time --preview
```

### Deployments

```bash
coolify deploy list
coolify deploy name my-application
coolify deploy batch api,worker,frontend --force
coolify deploy cancel <deployment-uuid>
```

### Databases and Services

```bash
coolify database get <uuid>
coolify database create postgresql --server-uuid <uuid> --project-uuid <uuid> --environment-name production
coolify database backup list <database-uuid>
coolify service get <uuid>
coolify service create <type> --project-uuid <uuid> --server-uuid <uuid> --instant-deploy
```

## Common Aliases

- `coolify app` | `coolify apps` | `coolify application` | `coolify applications`
- `coolify service` | `coolify services` | `coolify svc`
- `coolify database` | `coolify databases` | `coolify db` | `coolify dbs`
- `coolify teams` | `coolify team`

## Full Reference

- Full command and parameter catalog: ./llms-full.txt
- Regenerate docs: `go run ./coolify docs llms`