TeamCity On-Premises 2026.1 Help

Command Reference

This page provides a quick reference for all available TeamCity CLI commands. Each command group links to a detailed page with full descriptions, flags, and examples.

Authentication

Manage server authentication. See Authentication for details.

Command

Description

teamcity auth login

Authenticate with a TeamCity server

teamcity auth logout

Log out from a TeamCity server

teamcity auth status

Show authentication status

Runs

Start, monitor, and manage builds. See Managing runs for details.

Command

Description

teamcity run artifacts

List artifacts

teamcity run cancel

Cancel a run

teamcity run changes

Show VCS changes

teamcity run comment

Set or view comment

teamcity run diff

Compare two runs and show differences

teamcity run download

Download artifacts

teamcity run list

List recent runs

teamcity run log

View log

teamcity run pin

Pin to prevent cleanup

teamcity run restart

Restart a run

teamcity run start

Start a new run

teamcity run tag

Add tags

teamcity run tests

Show test results

teamcity run tree

Display snapshot dependency tree

teamcity run unpin

Unpin a run

teamcity run untag

Remove tags

teamcity run view

View details

teamcity run watch

Watch a run until it completes

Jobs

View and configure build configurations. See Managing jobs for details.

Command

Description

teamcity job list

List jobs

teamcity job param delete

Delete a job parameter

teamcity job param get

Get a job parameter value

teamcity job param list

List job parameters

teamcity job param set

Set a job parameter value

teamcity job pause

Pause a job

teamcity job resume

Resume a paused job

teamcity job tree

Display snapshot dependency tree

teamcity job view

View job details

Projects

Browse projects and manage parameters and settings. See Managing projects for details.

Command

Description

teamcity project cloud image

Manage cloud images

teamcity project cloud instance

Manage cloud instances

teamcity project cloud profile

Manage cloud profiles

teamcity project connection authorize

Open a browser to authorize the current TeamCity user against a connection

teamcity project connection create

Create a project connection

teamcity project connection delete

Delete a project connection

teamcity project connection list

List project connections

teamcity project create

Create a project

teamcity project list

List projects

teamcity project param delete

Delete a project parameter

teamcity project param get

Get a project parameter value

teamcity project param list

List project parameters

teamcity project param set

Set a project parameter value

teamcity project settings export

Export project settings as Kotlin DSL or XML

teamcity project settings status

Show versioned settings sync status

teamcity project settings validate

Validate Kotlin DSL configuration locally

teamcity project ssh delete

Delete an SSH key

teamcity project ssh generate

Generate an SSH key pair

teamcity project ssh list

List SSH keys

teamcity project ssh upload

Upload an SSH private key

teamcity project token get

Get the value of a secure token

teamcity project token put

Store a secret and get a secure token

teamcity project tree

Display project hierarchy as a tree

teamcity project vcs create

Create a VCS root

teamcity project vcs delete

Delete a VCS root

teamcity project vcs list

List VCS roots

teamcity project vcs test

Test a VCS root connection

teamcity project vcs view

View VCS root details

teamcity project view

View project details

Queues

Manage the build queue. See Managing the build queue for details.

Command

Description

teamcity queue approve

Approve a queued run

teamcity queue list

List queued runs

teamcity queue remove

Remove a run from the queue

teamcity queue top

Move a run to the top of the queue

Agents

Monitor and control build agents. See Managing agents for details.

Command

Description

teamcity agent authorize

Authorize an agent

teamcity agent deauthorize

Deauthorize an agent

teamcity agent disable

Disable an agent

teamcity agent enable

Enable an agent

teamcity agent exec

Execute command on agent

teamcity agent jobs

Show jobs an agent can run

teamcity agent list

List build agents

teamcity agent move

Move an agent to a different pool

teamcity agent reboot

Reboot an agent

teamcity agent term

Open interactive terminal to agent

teamcity agent view

View agent details

Agent Pools

Manage agent pool assignments. See Managing agent pools for details.

Command

Description

teamcity pool link

Link a project to an agent pool

teamcity pool list

List agent pools

teamcity pool unlink

Unlink a project from an agent pool

teamcity pool view

View pool details

API

Make raw REST API requests. See REST API access for details.

Command

Description

teamcity api <endpoint>

Make an authenticated API request

Aliases

Create custom command shortcuts. See Aliases for details.

Command

Description

teamcity alias delete

Delete an alias

teamcity alias list

List configured aliases

teamcity alias set

Create a command alias

Configs

Command

Description

teamcity config get

Get a configuration value

teamcity config list

List configuration settings

teamcity config set

Set a configuration value

Command

Description

teamcity link

Bind this repository to a TeamCity project

Pipelines

Command

Description

teamcity pipeline create

Create a new pipeline from YAML

teamcity pipeline delete

Delete a pipeline

teamcity pipeline list

List pipelines

teamcity pipeline pull

Download pipeline YAML

teamcity pipeline push

Upload pipeline YAML

teamcity pipeline schema

Print the pipeline JSON schema for the current server

teamcity pipeline validate

Validate pipeline YAML against server schema

teamcity pipeline view

View pipeline details

Skills

Manage AI agent integration. See AI agent integration for details.

Command

Description

teamcity skill install

Install skills for AI coding agents

teamcity skill list

List available skills bundled with this release

teamcity skill remove

Remove skills from AI coding agents

teamcity skill update

Update skills for AI coding agents

Updates

Command

Description

teamcity update

Check for CLI updates

06 May 2026