TeamCity CLI (teamcity)
Quick Start
teamcity auth status # Check authentication
teamcity run list --status failure # Find failed builds
teamcity run log <id> --failed # Full failure diagnostics
Do not guess flags or syntax. Use the Command Reference or teamcity <command> --help. Fall back to teamcity api /app/rest/... when needed. Builds are runs (teamcity run), build configurations are jobs (teamcity job).
Core Commands
| Area |
Commands |
| Builds |
run list, view, start, watch, log, cancel, restart, tests, changes |
| Artifacts |
run artifacts, run download |
| Metadata |
run pin/unpin, run tag/untag, run comment |
| Jobs |
job list, view, tree, pause/resume, param list/get/set/delete |
| Projects |
project list, view, tree, param, token put/get, settings export/status/validate |
| Queue |
queue list, approve, remove, top |
| Agents |
agent list, view, enable/disable, authorize/deauthorize, exec, term, reboot, move |
| Pools |
pool list, view, link/unlink |
| API |
teamcity api <endpoint> — raw REST API access |
Quick Workflows
Investigate failure: teamcity run list --status failure → teamcity run log <id> --failed → teamcity run tests <id> --failed
From a URL: Extract build ID from https://host/buildConfiguration/ConfigId/12345 → teamcity run view 12345
Start build: teamcity run start <job-id> --branch <branch> --watch
Find jobs: teamcity project list → teamcity job list --project <id>
Validate Kotlin DSL: teamcity project settings validate (not mvn compile — see Workflows)
References
- Command Reference - All commands and flags
- Workflows - URL handling, failure investigation, artifacts, agents, and more
- Output Formats - JSON, plain text, scripting
1---2name: teamcity-cli3description: Use when working with TeamCity CI/CD or when user provides a TeamCity build URL. Use `teamcity` CLI for builds, logs, jobs, queues, and agents.4---56# TeamCity CLI (`teamcity`)78## Quick Start910```bash11teamcity auth status # Check authentication12teamcity run list --status failure # Find failed builds13teamcity run log <id> --failed # Full failure diagnostics14```1516**Do not guess flags or syntax.** Use the [Command Reference](references/commands.md) or `teamcity <command> --help`. Fall back to `teamcity api /app/rest/...` when needed. Builds are **runs** (`teamcity run`), build configurations are **jobs** (`teamcity job`).1718## Core Commands1920| Area | Commands |21|-----------|---------------------------------------------------------------------------------------------------|22| Builds | `run list`, `view`, `start`, `watch`, `log`, `cancel`, `restart`, `tests`, `changes` |23| Artifacts | `run artifacts`, `run download` |24| Metadata | `run pin/unpin`, `run tag/untag`, `run comment` |25| Jobs | `job list`, `view`, `tree`, `pause/resume`, `param list/get/set/delete` |26| Projects | `project list`, `view`, `tree`, `param`, `token put/get`, `settings export/status/validate` |27| Queue | `queue list`, `approve`, `remove`, `top` |28| Agents | `agent list`, `view`, `enable/disable`, `authorize/deauthorize`, `exec`, `term`, `reboot`, `move` |29| Pools | `pool list`, `view`, `link/unlink` |30| API | `teamcity api <endpoint>` — raw REST API access |3132## Quick Workflows3334**Investigate failure:** `teamcity run list --status failure` → `teamcity run log <id> --failed` → `teamcity run tests <id> --failed`35**From a URL:** Extract build ID from `https://host/buildConfiguration/ConfigId/12345` → `teamcity run view 12345`36**Start build:** `teamcity run start <job-id> --branch <branch> --watch`37**Find jobs:** `teamcity project list` → `teamcity job list --project <id>`38**Validate Kotlin DSL:** `teamcity project settings validate` (not `mvn compile` — see [Workflows](references/workflows.md))3940## References4142- [Command Reference](references/commands.md) - All commands and flags43- [Workflows](references/workflows.md) - URL handling, failure investigation, artifacts, agents, and more44- [Output Formats](references/output.md) - JSON, plain text, scripting
jetbrains