Green — success, links, positive Red — errors, failures, negative Yellow — warnings, running, caution Cyan — titles, names, emphasis Bold — headers, key labels Faint — secondary info, IDs, hints
jetbrains/teamcity-cli/gallery
/ teamcity cli screen gallery
134 screens
16 command groups
16 command groups
Reading this gallery
Every block is real CLI output, captured on each release — not screenshots or mockups. Skim top-to-bottom, jump by section from the sidebar, or filter by name.
press / to filter · T to toggle theme · Esc to clear
§ 01
Style Guide
The atoms the CLI uses to communicate. Treat these as non-negotiable until we decide to rework them together.
Colors & Text Styles
Status Icons
✓ Success build completed successfully ✗ Failed build finished with failures ● Running build is currently executing ◦ Queued build is waiting in queue ⊘ Canceled build was canceled by a user ✗ Error internal or infrastructure error ? Unknown unknown status
Messages
✓ Logged in as Viktor Tiulpin 3 runs matched your filters ! Token expires in 2 days Tip: Use --limit to show more runs Error: job "NonExistent_Build" not found Tip: Run 'teamcity job list' to see available jobs
Table Rendering
ID NAME STATUS POOL 1 linux-agent-01 Connected Default 2 linux-agent-02 Connected Default 3 mac-agent-01 Disconnected macOS 4 cloud-agent-01 Disabled Cloud
Tree Rendering
My Application MyApp ├── Build MyApp_Build ├── Run Tests MyApp_Test └── Deploy MyApp_Deploy └── Smoke Tests MyApp_Smoke
§ 02
Runs
List, start, watch, diff, and manage builds.
teamcity run list
$ teamcity run list
STATUS RUN JOB BRANCH TRIGGERED BY DURATION AGE ✓ Success 45231 #831 MyApp_Build main Viktor Tiulpin 2m 13s 2h ago ✗ Failed 45230 #442 MyApp_Test feature/auth CI Bot 5m 1s 3h ago ● Running 45229 #830 MyApp_Deploy main Viktor Tiulpin 1m 22s now ✓ Success 45228 #829 MyApp_Build fix/memory-leak Anna Kowalski 45s 5h ago ✗ Failed 45227 #126 MyApp_IntTest main schedule 12m 45s 8h ago ◦ Queued 45226 # MyApp_Build feature/onboard GitHub Hook - 1d ago ✓ Success 45225 #118 MyApp_Lint main CI Bot 12s 1d ago
teamcity run view 45231
$ teamcity run view 45231
✓ Build 45231 #831 · main Triggered by Viktor Tiulpin · 2h ago · Took 2m 13s Agent: linux-agent-01 Tags: release, v1.0.0 View in browser: https://tc.example.com/viewLog.html?buildId=45231
teamcity run start MyApp_Build --no-input
$ teamcity run start MyApp_Build --no-input
✓ Queued run 100 #100 for MyApp_Build URL: https://tc.example.com/viewLog.html?buildId=100 Follow logs: teamcity run log -f 100
teamcity run restart 1 --no-input
$ teamcity run restart 1 --no-input
✓ Queued run 100 #100 for MyApp_Build (restart of 45231)
Job: MyApp_Build
Branch: main
URL: https://tc.example.com/viewLog.html?buildId=100
teamcity run watch --logs 45229
$ teamcity run watch --logs 45229
● Deploy Staging 45229 #830 https://tc.example.com/viewLog.html?buildId=45229 · Running (67%) [12:01:10] Downloading artifacts from Build #831 [12:01:12] Extracting app.jar (12.4 MB) [12:01:15] Verifying checksums... OK [12:01:18] Starting: deploy.sh --env staging [12:01:22] Stopping existing service... [12:01:25] Deploying version 1.0.0 to staging-01 [12:01:30] Deploying version 1.0.0 to staging-02 [12:01:35] Health check staging-01: 200 OK [12:01:38] Health check staging-02: 200 OK [12:01:40] Updating load balancer config... [12:01:42] Draining old instances... [12:01:45] Deploy complete. 2/2 instances healthy q quit · teamcity agent term 1
teamcity run log 1 --tail 10
$ teamcity run log 1 --tail 10
Build started Step 1/3: Compile (go build) Starting: go build -o bin/app ./cmd/app Process exited with code 0 Step 2/3: Test (go test) Starting: go test -race ./... ok myapp/internal/auth 0.152s ok myapp/internal/pool 0.089s ok myapp/internal/handler 0.523s Step 3/3: Package Build finished
teamcity run diff 45231 45230
$ teamcity run diff 45231 45230
! "teamcity run diff" is experimental: flags, output, and JSON schema may change or the command may be removed without notice. It is intentionally undocumented — do not rely on it in scripts. COMPARING ✓ 45231 #831 → ✗ 45230 #442 Job: Build · Branch: main → feature/auth STATUS - Success + Failed PROBLEMS + Compilation failed with 3 errors TESTS - 145 passed + 140 passed, 2 failed, 3 ignored New failures: ✗ TestAuthHandler/expired_session context deadline exceeded ✗ TestAuthHandler/invalid_token Expected status 401, got 200 CHANGES - abc1234 vtiulpin Fix memory leak in connection pool - def5678 akowalski Add graceful shutdown handler - 789abcd lchen Update CI pipeline configuration + fed9876 lchen Add OAuth2 handler PARAMETERS + new.flag: true ~ version: 1.0.0 → 1.0.1 AGENT - linux-agent-01 + DURATION - 2m 13s + 5m 0s (+2m 47s) Changed: status, problems, tests, changes, parameters, agent, duration View - https://tc.example.com/viewLog.html?buildId=45231 View + https://tc.example.com/viewLog.html?buildId=45230
teamcity run artifacts 1
$ teamcity run artifacts 1
ARTIFACTS (6 files, 13 MiB total) NAME SIZE app.jar 12 MiB test-report.html 234 KiB coverage.xml 44 KiB checksums.sha256 512 B logs/build.log 45 KiB logs/test.log 12 KiB Download all: teamcity run download 1 Download one: teamcity run download 1 -a "<name>"
teamcity run download 45231
$ teamcity run download 45231
Downloading 3 artifacts (12.6 MiB total) to ./artifacts/ NAME SIZE app.jar 12 MiB ✓ test-report.html 234 KiB ✓ logs/build.log 45 KiB ✓ ✓ 3 artifacts downloaded
teamcity run changes 1
$ teamcity run changes 1
CHANGES (3 commits) abc1234 vtiulpin 2h ago Fix memory leak in connection pool M src/pool/connection.go M src/pool/connection_test.go def5678 akowalski 5h ago Add graceful shutdown handler A src/shutdown/handler.go M src/main.go 789abcd lchen 8h ago Update CI pipeline configuration M .teamcity.yml # For full diff: git diff 789abcd^..abc1234
teamcity run tests 1
$ teamcity run tests 1
View in browser: https://tc.example.com/viewLog.html?buildId=45231?buildTab=tests TESTS: 145 passed ✓ TestAuthHandler/valid_token ✓ TestConnectionPool/acquire ✓ TestConnectionPool/release ✓ TestShutdown/graceful ✓ TestMigration/forward
teamcity run tree 45229
$ teamcity run tree 45229
● Deploy Staging 45229 ├── ✓ Build 45231 │ ├── ✓ Lint 45225 │ └── ✓ Compile 45240 └── ✗ Run Tests 45230 └── ✓ Build 45231 ├── ✓ Lint 45225 └── ✓ Compile 45240
teamcity run cancel --yes 45233
$ teamcity run cancel --yes 45233
✓ Canceled #45233
teamcity run pin 1 -m "Release candidate"
$ teamcity run pin 1 -m "Release candidate"
✓ Pinned #1
Comment: Release candidate
teamcity run unpin 1
$ teamcity run unpin 1
✓ Unpinned #1
teamcity run tag 1 release v1.0.0
$ teamcity run tag 1 release v1.0.0
✓ Added 2 tag(s) to #1
Tags: release, v1.0.0
teamcity run untag 1 release
$ teamcity run untag 1 release
✓ Removed 1 tag(s) from #1
teamcity run comment 1
$ teamcity run comment 1
No comment set on #1
Tip: Add one with 'teamcity run comment 1 --set "<text>"'
teamcity run comment 1 "Ready for prod"
$ teamcity run comment 1 "Ready for prod"
✓ Set comment on #1
Comment: Ready for prod
§ 03
Jobs
Build configurations: list, view, pause, parameters.
teamcity job list
$ teamcity job list
ID NAME PROJECT STATUS MyApp_Build Build My Application Active MyApp_Test Run Tests My Application Active MyApp_Deploy Deploy Staging My Application Paused MyApp_IntTest Integration Tests My Application Active MyApp_Lint Lint My Application Active
teamcity job view MyApp_Build
$ teamcity job view MyApp_Build
Build ID: MyApp_Build Project: My Application (MyApp) Status: Active View in browser: https://tc.example.com/viewType.html?buildTypeId=MyApp_Build
teamcity job tree MyApp_Build
$ teamcity job tree MyApp_Build
Build ├── ▲ Dependents │ ├── Run Tests MyApp_Test │ │ └── Deploy Staging MyApp_Deploy │ └── Integration Tests MyApp_IntTest │ └── Deploy Staging MyApp_Deploy (circular) └── ▼ Dependencies └── Lint MyApp_Lint
teamcity job pause MyApp_Deploy
$ teamcity job pause MyApp_Deploy
✓ Paused job MyApp_Deploy
teamcity job resume MyApp_Deploy
$ teamcity job resume MyApp_Deploy
✓ Resumed job MyApp_Deploy
teamcity job param list MyApp_Build
$ teamcity job param list MyApp_Build
NAME VALUE env.JAVA_HOME /usr/lib/jvm/java-17 env.GOVERSION 1.26 version 1.0.0 deploy.target staging build.parallel 4
teamcity job param get MyApp_Build env.JAVA_HOME
$ teamcity job param get MyApp_Build env.JAVA_HOME
value1
teamcity job param set MyApp_Build env.JAVA_HOME /opt/jdk
$ teamcity job param set MyApp_Build env.JAVA_HOME /opt/jdk
✓ Set parameter env.JAVA_HOME
teamcity job param delete MyApp_Build env.JAVA_HOME
$ teamcity job param delete MyApp_Build env.JAVA_HOME
✓ Deleted parameter env.JAVA_HOME
§ 04
Agents
List agents, view status, open terminals, execute commands.
teamcity agent list
$ teamcity agent list
ID NAME POOL STATUS 1 linux-agent-01 Default Connected 2 linux-agent-02 Default Connected 3 windows-agent-01 Windows Connected 4 mac-agent-01 macOS Disconnected 5 cloud-agent-01 Cloud Disabled
teamcity agent view 1
$ teamcity agent view 1
linux-agent-01 ID: 1 Pool: Default Status: Connected Connected: Yes Enabled: Yes Authorized: Yes Current build: Deploy Staging 45229 #830 () View in browser: https://tc.example.com/agentDetails.html?id=1 Open terminal: teamcity agent term 1
teamcity agent jobs 1
$ teamcity agent jobs 1
Compatible Jobs (5)
ID NAME PROJECT
MyApp_Build Build My Application
MyApp_Test Run Tests My Application
MyApp_Lint Lint My Application
MyApp_IntTest Integration Tests My Application
Infra_Validate Validate Infrastructure
teamcity agent enable 1
$ teamcity agent enable 1
✓ Enabled agent linux-agent-01
teamcity agent disable 1
$ teamcity agent disable 1
✓ Disabled agent linux-agent-01
teamcity agent authorize 1
$ teamcity agent authorize 1
✓ Authorized agent linux-agent-01
teamcity agent deauthorize 1
$ teamcity agent deauthorize 1
✓ Deauthorized agent linux-agent-01
teamcity agent move 1 2
$ teamcity agent move 1 2
✓ Moved agent linux-agent-01 to pool 2
teamcity agent reboot --yes 1
$ teamcity agent reboot --yes 1
✓ Reboot initiated for linux-agent-01
teamcity agent term linux-agent-01
$ teamcity agent term linux-agent-01
✓ Connected to linux-agent-01 https://tc.example.com/agentDetails.html?id=1 builduser@linux-agent-01:~$ uname -a Linux linux-agent-01 5.15.0-1056-aws #61-Ubuntu SMP x86_64 GNU/Linux builduser@linux-agent-01:~$ df -h /opt/buildagent Filesystem Size Used Avail Use% Mounted on /dev/nvme1n1 200G 87G 113G 44% /opt/buildagent builduser@linux-agent-01:~$ docker ps --format '{{.Names}} {{.Status}}' tc-build-45229 Up 3 minutes tc-build-45231 Up 12 minutes builduser@linux-agent-01:~$ free -h | head -2 total used free shared buff/cache available Mem: 31Gi 18Gi 2.1Gi 312Mi 11Gi 12Gi builduser@linux-agent-01:~$
teamcity agent exec linux-agent-01 -- top -bn1 | head -5
$ teamcity agent exec linux-agent-01 -- top -bn1 | head -5
top - 19:31:45 up 14 days, 3:22, 0 users, load average: 4.12, 3.87, 3.54 Tasks: 287 total, 3 running, 284 sleeping, 0 stopped, 0 zombie %Cpu(s): 42.3 us, 5.1 sy, 0.0 ni, 51.2 id, 0.8 wa, 0.0 hi, 0.6 si MiB Mem : 32168.4 total, 2152.3 free, 18724.1 used, 11292.0 buff/cache MiB Swap: 8192.0 total, 8192.0 free, 0.0 used. 12876.4 avail Mem
§ 05
Queue
Inspect and reorder the build queue.
teamcity queue list
$ teamcity queue list
ID JOB BRANCH STATE WAIT REASON 45233 MyApp_Build feature/onboard queued All compatible agents are busy 45234 MyApp_Test main queued Waiting for build #45233 in queue 45235 MyApp_IntTest main queued Waiting for build #45234 in queue 45236 MyApp_Build develop queued Build queue is paused 45237 MyApp_Deploy main queued Waiting for approval
teamcity queue remove --yes 100
$ teamcity queue remove --yes 100
✓ Removed #100 from queue
teamcity queue top 100
$ teamcity queue top 100
✓ Moved run 100 to top of queue
teamcity queue approve 100
$ teamcity queue approve 100
✓ Approved run 100
§ 06
Pools
Agent pools and project assignments.
teamcity pool list
$ teamcity pool list
ID NAME MAX AGENTS 0 Default unlimited 1 Linux Agents 10 2 Windows Agents 5 3 macOS Agents 3 4 Cloud (Auto-scale) 50
teamcity pool view 0
$ teamcity pool view 0
Default ID: 0 Max Agents: unlimited Agents (3) 1 linux-agent-01 Connected 2 linux-agent-02 Connected 6 linux-agent-03 Disconnected Projects (2) _Root Root project MyApp My Application View in browser: https://tc.example.com/agents.html?tab=agentPools&poolId=0
teamcity pool link 0 MyApp
$ teamcity pool link 0 MyApp
✓ Linked project MyApp to pool 0
teamcity pool unlink 0 MyApp
$ teamcity pool unlink 0 MyApp
✓ Unlinked project MyApp to pool 0
§ 07
Projects
Project tree, VCS, SSH, cloud, parameters, tokens.
teamcity project list
$ teamcity project list
ID NAME PARENT _Root Root project - MyApp My Application _Root MyApp_Frontend Frontend MyApp MyApp_Backend Backend MyApp Infrastructure Infrastructure _Root
teamcity project view MyApp
$ teamcity project view MyApp
My Application ID: MyApp Parent: _Root Description: Main product monorepo View in browser: https://tc.example.com/project.html?projectId=MyApp
teamcity project tree
$ teamcity project tree
Root project _Root ├── Infrastructure Infrastructure │ └── Infrastructure Deploy Infra_Deploy ⬡ pipeline · 2 jobs └── My Application MyApp ├── Backend MyApp_Backend ├── Frontend MyApp_Frontend │ └── Frontend CI Frontend_CI ⬡ pipeline · 3 jobs ├── CI MyApp_CI ⬡ pipeline · 2 jobs ├── Nightly MyApp_Nightly ⬡ pipeline · 3 jobs ├── Release MyApp_Release ⬡ pipeline · 4 jobs ├── Build MyApp_Build ├── Deploy Staging MyApp_Deploy ├── Integration Tests MyApp_IntTest ├── Lint MyApp_Lint └── Run Tests MyApp_Test
teamcity project settings status MyApp
$ teamcity project settings status MyApp
✓ My Application (MyApp) · synchronized Format Kotlin Sync enabled Build from VCS VCS Root MyApp_HttpsGithubComOrgRepoGit @ .teamcity Last sync Jan 27 (Jan 27 11:30) View https://tc.example.com/project.html?projectId=MyApp&tab=versionedSettings
teamcity project settings validate .teamcity
$ teamcity project settings validate .teamcity
Validating .teamcity ✓ Configuration valid Server: https://tc.example.com Projects: 5, Build configurations: 12
teamcity project settings export MyApp
$ teamcity project settings export MyApp
Exported kotlin settings to projectSettings.zip (45678 bytes)
teamcity project vcs list --project MyApp
$ teamcity project vcs list --project MyApp
ID NAME TYPE PROJECT MyApp_MainRepo Main Repo Git MyApp MyApp_ConfigRepo Config Repo Git MyApp MyApp_DocsRepo Documentation Git MyApp Shared_Libraries Shared Libraries Git _Root Legacy_SVN Legacy Codebase Subversion MyApp
teamcity project vcs view MyApp_MainRepo
$ teamcity project vcs view MyApp_MainRepo
Main Repo ID: MyApp_MainRepo Type: Git Project: MyApp URL: https://github.com/jetbrains/teamcity-cli.git Branch: refs/heads/main Auth Method: TEAMCITY_SSH_KEY SSH Key: deploy-key View in browser: https://tc.example.com/admin/editVcsRoot.html?vcsRootId=MyApp_MainRepo
teamcity project vcs create --project MyApp --name "New Repo" --url https://github.com/org/new-repo
$ teamcity project vcs create --project MyApp --name "New Repo" --url https://github.com/org/new-repo
✓ Created VCS root "New Repo" (MyApp_NewRepo) in project MyApp
teamcity project vcs test MyApp_MainRepo
$ teamcity project vcs test MyApp_MainRepo
Testing connection... ✓ ✓ Connection to "Main Repo" is working
teamcity project vcs delete --yes MyApp_Repo
$ teamcity project vcs delete --yes MyApp_Repo
✓ Deleted VCS root MyApp_Repo
teamcity project ssh list --project MyApp
$ teamcity project ssh list --project MyApp
NAME ENCRYPTED PUBLIC KEY deploy-key no ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAA... ci-key no ssh-ed25519 AAAAC3NzaC1lZDI1NTE5BBBB... backup-key yes ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB... github-app no ssh-ed25519 AAAAC3NzaC1lZDI1NTE5CCCC... staging-access yes ssh-rsa AAAAB3NzaC1yc2EAAAADAQCC...
teamcity project ssh generate --project MyApp --name ci-key
$ teamcity project ssh generate --project MyApp --name ci-key
✓ Generated SSH key "ci-key" in project MyApp
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5_generated_key
teamcity project ssh upload id_ed25519 --project MyApp --name deploy-key
$ teamcity project ssh upload id_ed25519 --project MyApp --name deploy-key
✓ Uploaded SSH key "deploy-key" to project MyApp
teamcity project ssh delete deploy-key --project MyApp
$ teamcity project ssh delete deploy-key --project MyApp
✓ Deleted SSH key "deploy-key" from project MyApp
teamcity project connection list --project MyApp
$ teamcity project connection list --project MyApp
ID NAME TYPE PROJECT_EXT_1 GitHub App GitHubApp PROJECT_EXT_2 Docker Registry DockerRegistry PROJECT_EXT_3 AWS Connection AWSConnection PROJECT_EXT_4 Slack Notifier SlackConnection PROJECT_EXT_5 Jira Cloud JiraCloud
teamcity project cloud profile list
$ teamcity project cloud profile list
ID NAME TYPE aws-prod AWS Production amazon aws-staging AWS Staging amazon azure-eu Azure EU azure gcp-us GCP US Central google k8s-local Kubernetes On-Prem kubernetes
teamcity project cloud profile view aws-prod
$ teamcity project cloud profile view aws-prod
AWS Production
ID: aws-prod
Type: amazon
Project: MyApp
teamcity project cloud image list
$ teamcity project cloud image list
NAME PROFILE ID ubuntu-22-large AWS Production img-1 ubuntu-22-xlarge AWS Production img-2 windows-2022 Azure EU img-3 debian-12-small AWS Staging img-4 ubuntu-22-gpu GCP US Central img-5
teamcity project cloud image view img-1
$ teamcity project cloud image view img-1
ubuntu-22-large
ID: id:img-1,profileId:aws-prod
Profile: AWS Production
teamcity project cloud image start img-1
$ teamcity project cloud image start img-1
✓ Started instance i-new-instance from image ubuntu-22-large
teamcity project cloud instance list
$ teamcity project cloud instance list
NAME STATE IMAGE AGENT STARTED ID agent-cloud-1 running ubuntu-22-large agent-cloud-1 i-0a24f... agent-cloud-2 running ubuntu-22-large agent-cloud-2 i-0b35e... agent-cloud-3 starting ubuntu-22-xlarge i-0c46d... agent-azure-1 running windows-2022 agent-azure-1 vm-eu-01 agent-k8s-5 running ubuntu-22-gpu agent-k8s-5 gke-node-5
teamcity project cloud instance view i-024...
$ teamcity project cloud instance view i-024...
agent-cloud-1
ID: i-0245b46070c443201
State: running
Image: ubuntu-22-large
Agent: agent-cloud-1
Started: Jan 01
teamcity project cloud instance stop i-024...
$ teamcity project cloud instance stop i-024...
✓ Stopped instance i-0245b46070c443201
teamcity project param list MyApp
$ teamcity project param list MyApp
NAME VALUE env.DEPLOY_ENV staging env.JAVA_HOME /usr/lib/jvm/java-17 version.prefix 1.0 docker.registry ghcr.io/myorg system.teamcity.build.branch main
teamcity project param get MyApp env.DEPLOY_ENV
$ teamcity project param get MyApp env.DEPLOY_ENV
value1
teamcity project param set MyApp env.DEPLOY_ENV prod
$ teamcity project param set MyApp env.DEPLOY_ENV prod
✓ Set parameter env.DEPLOY_ENV
teamcity project param delete MyApp env.DEPLOY_ENV
$ teamcity project param delete MyApp env.DEPLOY_ENV
✓ Deleted parameter env.DEPLOY_ENV
teamcity project token put MyApp "s3cret-db-password"
$ teamcity project token put MyApp "s3cret-db-password"
credentialsJSON:abc123
Use in versioned settings as: credentialsJSON:abc123
teamcity project token get MyApp credentialsJSON:abc123
$ teamcity project token get MyApp credentialsJSON:abc123
s3cret-db-password
§ 08
Pipelines
YAML pipeline lifecycle: validate, push, pull.
teamcity pipeline list
$ teamcity pipeline list
ID NAME PROJECT JOBS MyApp_CI CI My Application 2 MyApp_Release Release My Application 4 MyApp_Nightly Nightly My Application 3 Infra_Deploy Infrastructure Deploy Infrastructure 2 Frontend_CI Frontend CI Frontend 3
teamcity pipeline view MyApp_CI
$ teamcity pipeline view MyApp_CI
CI ID: MyApp_CI Project: My Application (MyApp) Head Job: MyApp_CI Jobs (2): build Build test Test
teamcity pipeline create Onboarding --project MyApp --vcs-root MyApp_MainRepo --file .teamcity.yml
$ teamcity pipeline create Onboarding --project MyApp --vcs-root MyApp_MainRepo --file .teamcity.yml
✓ Created pipeline "Onboarding" (MyApp_Onboarding)
https://tc.example.com/pipeline/MyApp_Onboarding
teamcity pipeline validate .teamcity.yml
$ teamcity pipeline validate .teamcity.yml
✓ .teamcity.yml is valid
Jobs: build, test
teamcity pipeline delete --yes MyApp_CI
$ teamcity pipeline delete --yes MyApp_CI
✓ Deleted pipeline "CI" (MyApp_CI)
teamcity pipeline push MyApp_CI .teamcity.yml
$ teamcity pipeline push MyApp_CI .teamcity.yml
✓ Updated pipeline MyApp_CI
teamcity pipeline pull MyApp_CI
$ teamcity pipeline pull MyApp_CI
✓ Written to .teamcity.yml
§ 09
Auth
Login, logout, multi-server status.
teamcity auth status
$ teamcity auth status
✓ Logged in to https://tc.example.com User: Administrator (admin) · environment variable Server: TeamCity 2025.7 (build 197398) ✓ API compatible
teamcity auth status
$ teamcity auth status
✓ Logged in to https://tc.example.com (default) User: Viktor Tiulpin (vtiulpin) · system keyring Token expires: Dec 31, 2026 Server: TeamCity 2025.7 (build 197398) ✓ API compatible ✓ Guest access to https://staging.tc.example.com Server: TeamCity 2025.7 (build 197398) ✓ API compatible ✓ Logged in to https://legacy.tc.example.com User: Viktor Tiulpin (vtiulpin) · system keyring ✗ Token expired on Mar 15, 2025 Run teamcity auth login to re-authenticate Server: TeamCity 2024.3 (build 185432) ! CLI requires TeamCity 2024.7 or later
teamcity auth login
$ teamcity auth login
Secure browser login available on this server Opening browser for authentication... → Approve access in TeamCity ✓ ✓ Logged in as Viktor Tiulpin ✓ Token stored in system keyring Token expires: Dec 31, 2026
teamcity auth logout
$ teamcity auth logout
Logged out from https://tc.example.com
§ 10
Config
CLI configuration values.
teamcity config list
$ teamcity config list
Config: ~/.config/tc/config.yml default_server=https://tc.example.com https://tc.example.com (default) guest=true ro=false https://staging.tc.example.com guest=false ro=false token_expiry=2026-05-17T14:39:53.398Z https://ai.tc.example.com guest=false ro=false https://nightly.tc.example.com guest=false ro=false token_expiry=2026-05-08T10:59:42.408Z Aliases: 1 configured (run 'teamcity alias list' to view) Environment overrides: ! TEAMCITY_TOKEN=**** ! TEAMCITY_URL=https://tc.example.com
teamcity config get default_server
$ teamcity config get default_server
https://tc.example.com
teamcity config set default_server https://tc.example.com
$ teamcity config set default_server https://tc.example.com
✓ Set default_server to "https://tc.example.com"
§ 11
Aliases
Command shortcuts.
teamcity alias list
$ teamcity alias list
NAME EXPANSION TYPE build run built-in buildtype job built-in testing run expansion
teamcity alias set mybuilds "run list"
$ teamcity alias set mybuilds "run list"
✓ Added alias "mybuilds"
teamcity alias delete mybuilds
$ teamcity alias delete mybuilds
✓ Deleted alias "mybuilds"
§ 12
Skills
AI coding agent skills: install, update, remove.
teamcity skill list
$ teamcity skill list
Name Version Description teamcity-cli 0.9.1 Use when working with TeamCity CI/CD or when user provides a TeamCity build URL. Use `teamcity` CLI for builds, logs, jobs, queues, agents, and pipelines. (default)
teamcity skill install teamcity-cli
$ teamcity skill install teamcity-cli
✓ Installed teamcity-cli for warp (0.9.1) ✓ Installed teamcity-cli for claude-code (0.9.1) ✓ Installed teamcity-cli for codex (0.9.1) ✓ Installed teamcity-cli for opencode (0.9.1) ✓ Installed teamcity-cli for cursor (0.9.1) ✓ Installed teamcity-cli for droid (0.9.1) ✓ Installed teamcity-cli for antigravity (0.9.1) ✓ Installed teamcity-cli for gemini-cli (0.9.1) ✓ Installed teamcity-cli for junie (0.9.1)
teamcity skill update
$ teamcity skill update
✓ Skill teamcity-cli already up to date (0.9.1)
teamcity skill remove teamcity-cli
$ teamcity skill remove teamcity-cli
✓ Removed teamcity-cli from warp ✓ Removed teamcity-cli from claude-code ✓ Removed teamcity-cli from codex ✓ Removed teamcity-cli from opencode ✓ Removed teamcity-cli from cursor ✓ Removed teamcity-cli from droid ✓ Removed teamcity-cli from antigravity ✓ Removed teamcity-cli from gemini-cli ✓ Removed teamcity-cli from junie
§ 13
API
Raw authenticated REST calls.
teamcity api /app/rest/server
$ teamcity api /app/rest/server
{
"buildNumber": "197398",
"version": " (build 197398)",
"versionMajor": 2025,
"versionMinor": 7,
"webUrl": "https://tc.example.com"
}
§ 14
Update
Check for new CLI releases.
teamcity update
$ teamcity update
Checking for updates... vdev → v0.9.1: Visit https://github.com/JetBrains/teamcity-cli/releases/latest https://github.com/JetBrains/teamcity-cli/releases/tag/v0.9.1
§ 15
Errors
Error message shapes and hints.
Not Found
Error: run "999999" not found
Tip: Run 'teamcity run list' to see available runs
Authentication Failed
Error: authentication failed: invalid or expired credentials
Tip: Run 'teamcity auth login' to re-authenticate
Permission Denied
Error: missing "Manage agents" permission
Tip: Ask your TeamCity administrator to grant this permission
Network Error
Error: cannot connect to https://tc.example.com: dial tcp: lookup tc.example.com: no such host
Tip: Check your network connection and verify the server URL
Read-Only Mode
Error: read-only mode: write operations are not allowed: POST /app/rest/buildQueue
Tip: Unset the TEAMCITY_RO environment variable to allow write operations
JSON Error Format
{
"error": {
"code": "not_found",
"message": "run \"999999\" not found",
"suggestion": "Run 'teamcity run list' to see available runs"
}
}
§ 16
Help Screens
Built-in --help output for every command group.
teamcity --help
$ teamcity --help
TeamCity CLI vdev
A command-line interface for interacting with TeamCity CI/CD server.
teamcity provides a complete experience for managing
TeamCity runs, jobs, projects and more from the command line.
Documentation: https://jb.gg/tc/docs
Report issues: https://jb.gg/tc/issues
Usage:
teamcity [flags]
teamcity [command]
CORE COMMANDS
job Manage jobs (build configurations)
pipeline Manage pipelines (YAML configurations)
project Manage projects
run Manage runs (builds)
INFRASTRUCTURE
agent Manage build agents
pool Manage agent pools
queue Manage build queue
CONFIGURATION
alias Manage command aliases
api Make an authenticated API request
auth Authenticate with TeamCity
config Manage CLI configuration
skill Manage AI coding agent skills
update Check for CLI updates
ADDITIONAL COMMANDS
completion Generate the autocompletion script for the specified shell
help Help about any command
Flags:
--debug Alias for --verbose
-h, --help help for teamcity
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
-v, --version version for teamcity
Use "teamcity [command] --help" for more information about a command.
teamcity run --help
$ teamcity run --help
List, view, start, and manage TeamCity runs (builds).
A run (called a build in the TeamCity UI) is a single execution of a
job. Use these commands to trigger runs, watch them live, download
artifacts and logs, inspect test results and VCS changes, and manage
run metadata (tags, comments, pins).
See: https://www.jetbrains.com/help/teamcity/build-results-page.html
Usage:
teamcity run [flags]
teamcity run [command]
Aliases:
run, build
LIFECYCLE
cancel Cancel a run
diff [experimental] Compare two runs and show differences
list List recent runs
restart Restart a run
start Start a new run
tree Display snapshot dependency tree
view View details
watch Watch a run until it completes
ARTIFACTS & LOGS
artifacts List artifacts
download Download artifacts
log View log
METADATA
comment Set or view comment
pin Pin to prevent cleanup
tag Add tags
unpin Unpin a run
untag Remove tags
ANALYSIS
changes Show VCS changes
tests Show test results
Flags:
-h, --help help for run
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity run [command] --help" for more information about a command.
teamcity job --help
$ teamcity job --help
List and manage TeamCity jobs (build configurations).
A job (referred to as a build configuration in the TeamCity UI) is the
recipe that turns source revisions into builds: VCS roots, build steps,
parameters, and triggers. Use these commands to browse jobs, inspect
their parameters and dependencies, and pause or resume them.
See: https://www.jetbrains.com/help/teamcity/creating-and-editing-build-configurations.html
Usage:
teamcity job [flags]
teamcity job [command]
Aliases:
job, buildtype
Available Commands:
list List jobs
param Manage job parameters
pause Pause a job
resume Resume a paused job
tree Display snapshot dependency tree
view View job details
Flags:
-h, --help help for job
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity job [command] --help" for more information about a command.
teamcity agent --help
$ teamcity agent --help
List, view, and manage TeamCity build agents.
Build agents run the jobs assigned by the TeamCity server. Use these
commands to inspect agent state, toggle availability, and open a shell
to a running agent.
See: https://www.jetbrains.com/help/teamcity/build-agent.html
Usage:
teamcity agent [flags]
teamcity agent [command]
VIEW
jobs Show jobs an agent can run
list List build agents
view View agent details
STATE
authorize Authorize an agent
deauthorize Deauthorize an agent
disable Disable an agent
enable Enable an agent
move Move an agent to a different pool
reboot Reboot an agent
SHELL
exec Execute command on agent
term Open interactive terminal to agent
Flags:
-h, --help help for agent
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity agent [command] --help" for more information about a command.
teamcity queue --help
$ teamcity queue --help
List and manage the TeamCity build queue.
The queue holds runs that are waiting for a compatible agent. Use
these commands to inspect pending runs, reorder them, approve guarded
runs, or remove entries.
See: https://www.jetbrains.com/help/teamcity/build-queue.html
Usage:
teamcity queue [flags]
teamcity queue [command]
Available Commands:
approve Approve a queued run
list List queued runs
remove Remove a run from the queue
top Move a run to the top of the queue
Flags:
-h, --help help for queue
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity queue [command] --help" for more information about a command.
teamcity pool --help
$ teamcity pool --help
List agent pools and manage project assignments.
Agent pools group build agents and bind them to specific projects,
so a project's builds only run on approved agents. Use these commands
to inspect pools and link or unlink projects.
See: https://www.jetbrains.com/help/teamcity/configuring-agent-pools.html
Usage:
teamcity pool [flags]
teamcity pool [command]
Available Commands:
link Link a project to an agent pool
list List agent pools
unlink Unlink a project from an agent pool
view View pool details
Flags:
-h, --help help for pool
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity pool [command] --help" for more information about a command.
teamcity project --help
$ teamcity project --help
List, view, and manage TeamCity projects.
A project groups related jobs, pipelines, VCS roots, parameters, and
cloud profiles. Use these commands to navigate the project hierarchy
and manage project-scoped resources (VCS roots, SSH keys, secure
tokens, versioned settings, cloud integrations, and connections).
See: https://www.jetbrains.com/help/teamcity/creating-and-editing-projects.html
Usage:
teamcity project [flags]
teamcity project [command]
Available Commands:
cloud Manage cloud profiles, images, and instances
connection Manage project connections
create Create a project
list List projects
param Manage project parameters
settings Manage versioned settings
ssh Manage SSH keys
token Manage secure tokens
tree Display project hierarchy as a tree
vcs Manage VCS roots
view View project details
Flags:
-h, --help help for project
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project [command] --help" for more information about a command.
teamcity pipeline --help
$ teamcity pipeline --help
List, view, validate, and manage TeamCity pipelines.
Pipelines are YAML-defined workflows that orchestrate one or more jobs
end-to-end. Use these commands to validate pipeline YAML against the
server schema, push changes, and pull the current definition.
See: https://www.jetbrains.com/help/teamcity/create-and-edit-pipelines.html
Usage:
teamcity pipeline [flags]
teamcity pipeline [command]
Available Commands:
create Create a new pipeline from YAML
delete Delete a pipeline
list List pipelines
pull Download pipeline YAML
push Upload pipeline YAML
validate Validate pipeline YAML against server schema
view View pipeline details
Flags:
-h, --help help for pipeline
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity pipeline [command] --help" for more information about a command.
teamcity auth --help
$ teamcity auth --help
Log in, log out, and inspect authentication state for TeamCity servers.
Credentials are stored in the system keyring by default and can be
overridden via TEAMCITY_URL and TEAMCITY_TOKEN environment variables
for CI/CD usage.
See: https://www.jetbrains.com/help/teamcity/managing-your-user-account.html#Managing+Access+Tokens
Usage:
teamcity auth [flags]
teamcity auth [command]
Available Commands:
login Authenticate with a TeamCity server
logout Log out from a TeamCity server
status Show authentication status
Flags:
-h, --help help for auth
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity auth [command] --help" for more information about a command.
teamcity config --help
$ teamcity config --help
Get, set, and list CLI configuration values.
Configuration is stored in ~/.teamcity/config.toml and covers the
default server, per-server flags (guest, read-only), and aliases.
Environment variables (TEAMCITY_URL, TEAMCITY_TOKEN, ...) override
the persisted values at runtime.
Usage:
teamcity config [flags]
teamcity config [command]
Available Commands:
get Get a configuration value
list List configuration settings
set Set a configuration value
Flags:
-h, --help help for config
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity config [command] --help" for more information about a command.
teamcity alias --help
$ teamcity alias --help
Create, list, and delete command shortcuts.
Aliases expand to full teamcity commands, so you can type 'tc rl'
instead of 'tc run list'. Aliases support positional placeholders
($1, $2, ...) and shell-style expansions via the --shell flag.
Usage:
teamcity alias [flags]
teamcity alias [command]
Available Commands:
delete Delete an alias
list List configured aliases
set Create a command alias
Flags:
-h, --help help for alias
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity alias [command] --help" for more information about a command.
teamcity skill --help
$ teamcity skill --help
Install, update, or remove TeamCity skills for AI coding agents.
Skills teach AI coding agents (Claude Code, Cursor, and others) how
to drive the teamcity CLI effectively. Skills can be installed
globally for the current user or locally into a project.
Usage:
teamcity skill [flags]
teamcity skill [command]
Available Commands:
install Install skills for AI coding agents
list List available skills bundled with this release
remove Remove skills from AI coding agents
update Update skills for AI coding agents
Flags:
-h, --help help for skill
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity skill [command] --help" for more information about a command.
teamcity project settings --help
$ teamcity project settings --help
View and manage versioned settings (Kotlin DSL) for a project.
Versioned settings allow you to store project configuration as code in a VCS repository.
This enables version control, code review, and automated deployment of CI/CD configuration.
See: https://www.jetbrains.com/help/teamcity/storing-project-settings-in-version-control.html
Usage:
teamcity project settings [flags]
teamcity project settings [command]
Available Commands:
export Export project settings as Kotlin DSL or XML
status Show versioned settings sync status
validate Validate Kotlin DSL configuration locally
Flags:
-h, --help help for settings
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project settings [command] --help" for more information about a command.
teamcity project vcs --help
$ teamcity project vcs --help
List, view, create, test, and delete VCS roots in a project.
A VCS root defines how TeamCity connects to a version control
repository (Git, Mercurial, Perforce, SVN, ...) so that jobs can
check out sources and react to changes.
See: https://www.jetbrains.com/help/teamcity/vcs-root.html
Usage:
teamcity project vcs [flags]
teamcity project vcs [command]
Available Commands:
create Create a VCS root
delete Delete a VCS root
list List VCS roots
test Test a VCS root connection
view View VCS root details
Flags:
-h, --help help for vcs
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project vcs [command] --help" for more information about a command.
teamcity project ssh --help
$ teamcity project ssh --help
List, upload, generate, and delete SSH keys in a project.
SSH keys uploaded to a project can be used by VCS roots and build
steps to authenticate with remote services without exposing private
keys in configuration or source control.
See: https://www.jetbrains.com/help/teamcity/ssh-keys-management.html
Usage:
teamcity project ssh [flags]
teamcity project ssh [command]
Available Commands:
delete Delete an SSH key
generate Generate an SSH key pair
list List SSH keys
upload Upload an SSH private key
Flags:
-h, --help help for ssh
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project ssh [command] --help" for more information about a command.
teamcity project connection --help
$ teamcity project connection --help
List OAuth and other connections configured in a project.
Connections let TeamCity talk to external services (GitHub, GitLab,
Bitbucket, Slack, Jira, Docker registries, ...) without storing
credentials in individual jobs.
See: https://www.jetbrains.com/help/teamcity/configuring-connections.html
Usage:
teamcity project connection [flags]
teamcity project connection [command]
Available Commands:
list List project connections
Flags:
-h, --help help for connection
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project connection [command] --help" for more information about a command.
teamcity project cloud --help
$ teamcity project cloud --help
List and manage cloud profiles, images, and instances for a project.
A cloud profile binds a project to a cloud provider (AWS, GCP, Azure,
Kubernetes, ...) and defines one or more images that TeamCity uses to
start ephemeral build agents on demand.
See: https://www.jetbrains.com/help/teamcity/agent-cloud-profile.html
Usage:
teamcity project cloud [flags]
teamcity project cloud [command]
Available Commands:
image Manage cloud images
instance Manage cloud instances
profile Manage cloud profiles
Flags:
-h, --help help for cloud
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project cloud [command] --help" for more information about a command.
teamcity project cloud profile --help
$ teamcity project cloud profile --help
Manage cloud profiles
Usage:
teamcity project cloud profile [flags]
teamcity project cloud profile [command]
Available Commands:
list List cloud profiles
view View cloud profile details
Flags:
-h, --help help for profile
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project cloud profile [command] --help" for more information about a command.
teamcity project cloud image --help
$ teamcity project cloud image --help
Manage cloud images
Usage:
teamcity project cloud image [flags]
teamcity project cloud image [command]
Available Commands:
list List cloud images
start Start a cloud instance from an image
view View cloud image details
Flags:
-h, --help help for image
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project cloud image [command] --help" for more information about a command.
teamcity project cloud instance --help
$ teamcity project cloud instance --help
Manage cloud instances
Usage:
teamcity project cloud instance [flags]
teamcity project cloud instance [command]
Available Commands:
list List cloud instances
stop Stop a cloud instance
view View cloud instance details
Flags:
-h, --help help for instance
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project cloud instance [command] --help" for more information about a command.
teamcity project token --help
$ teamcity project token --help
Manage secure tokens for versioned settings.
Secure tokens allow you to store sensitive values (passwords, API keys, etc.)
in TeamCity's credentials storage. The scrambled token can be safely committed
to version control and used in configuration files as credentialsJSON:<token>.
See: https://www.jetbrains.com/help/teamcity/storing-project-settings-in-version-control.html#Managing+Tokens
Usage:
teamcity project token [flags]
teamcity project token [command]
Available Commands:
get Get the value of a secure token
put Store a secret and get a secure token
Flags:
-h, --help help for token
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project token [command] --help" for more information about a command.
teamcity project param --help
$ teamcity project param --help
List, get, set, and delete project parameters.
Parameters are typed key-value pairs attached to a project. They drive
build behavior, can reference other parameters, and may be marked
as password (secure) so their values never appear in logs.
See: https://www.jetbrains.com/help/teamcity/configuring-build-parameters.html
Usage:
teamcity project param [flags]
teamcity project param [command]
Available Commands:
delete Delete a project parameter
get Get a project parameter value
list List project parameters
set Set a project parameter value
Flags:
-h, --help help for param
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity project param [command] --help" for more information about a command.
teamcity job param --help
$ teamcity job param --help
List, get, set, and delete job parameters.
Parameters are typed key-value pairs attached to a job. They drive
build behavior, can reference other parameters, and may be marked
as password (secure) so their values never appear in logs.
See: https://www.jetbrains.com/help/teamcity/configuring-build-parameters.html
Usage:
teamcity job param [flags]
teamcity job param [command]
Available Commands:
delete Delete a job parameter
get Get a job parameter value
list List job parameters
set Set a job parameter value
Flags:
-h, --help help for param
Global Flags:
--debug Alias for --verbose
--no-color Disable colored output
--no-input Disable interactive prompts
-q, --quiet Suppress non-essential output
-V, --verbose Show detailed output including debug info
Use "teamcity job param [command] --help" for more information about a command.
JetBrains
·
Developer Tools
·
The Drive to Develop
© 2026 JetBrains s.r.o.