TeamCity On-Premises 2026.1 Help

TeamCity CLI

TeamCity CLI is the official command-line interface for TeamCity. Type teamcity in your terminal to start builds, tail logs, manage agents and queues, and more.

TeamCity CLI in action

Features

  • Stay in your terminal — Start builds, view logs, manage queues — no browser needed.

  • Remote agent access — Shell into any build agent with teamcity agent term, or run commands with teamcity agent exec.

  • Real-time logs — Stream build output as it happens with teamcity run watch --logs.

  • Scriptable--json and --plain output for pipelines, plus direct REST API access via teamcity api.

  • Multi-server support — Authenticate with and switch between multiple TeamCity instances.

  • AI agent ready — Built-in skill for Claude Code, Cursor, and other AI coding agents — just run teamcity skill install.

Installing TeamCity CLI

Homebrew (recommended):

brew install jetbrains/utils/teamcity

Install script:

curl -fsSL https://jb.gg/tc/install | bash

Winget (recommended):

winget install JetBrains.TeamCityCLI

PowerShell (install script):

irm https://jb.gg/tc/install.ps1 | iex

npm (cross-platform):

npm install -g @jetbrains/teamcity-cli

For other methods (Scoop, Chocolatey, deb/rpm packages, building from source), see the getting started guide.

Quick start

# Authenticate with your TeamCity server teamcity auth login # List recent builds teamcity run list --limit 10 # Start a build and watch it run teamcity run start MyProject_Build --branch main --watch # View logs from the latest build of a job teamcity run log --job MyProject_Build # Check what's in the queue teamcity queue list

For a full walkthrough, see Getting started with TeamCity CLI.

What you can do

Topic

Description

Getting started

Install, authenticate, and run your first commands

Authentication

Token storage, guest access, multi-server setup, and CI/CD usage

Configuration

Configuration file, environment variables, and shell completion

Linking a repository

Bind a repo (or monorepo subdirectories) to TeamCity projects via teamcity.toml

Managing runs

Start, monitor, and manage builds

Managing pipelines

Author, validate, and sync .teamcity.yml pipelines

Managing jobs

View and configure build configurations

Managing projects

Browse projects, manage VCS roots, parameters, and versioned settings

Managing the build queue

Inspect queued builds, control priority, and approve builds

Managing agents

Monitor, control, and access build agents remotely

Managing agent pools

Assign projects and agents to pools

Managing cloud agents

Manage cloud profiles, images, and ephemeral agent instances

REST API access

Make authenticated API requests from the command line

Aliases

Create custom command shortcuts

Scripting and automation

JSON output, plain text mode, and CI/CD integration

Command reference

Quick reference for all available commands and flags

AI agent integration

Install the TeamCity skill for AI coding agents

Glossary

Definitions of CLI terms and how they map to TeamCity concepts

Anonymous usage statistics

What the CLI sends to JetBrains and how to opt out

06 May 2026