Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@jetbrains/teamcity-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TeamCity CLI

TeamCity CLI (teamcity) is an open-source command-line interface for TeamCity. Start builds, tail logs, manage agents and queues – without leaving your terminal.

Documentation – full guide with installation, authentication, and command reference.

cli cli

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

Installation

macOS (Homebrew):

brew install jetbrains/utils/teamcity

Linux:

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

Windows (Winget):

winget install JetBrains.TeamCityCLI

npm:

npm install -g @jetbrains/teamcity-cli

More installation methods (deb, rpm, Chocolatey, Scoop, build from source)

Debian/Ubuntu:

curl -fsSLO https://github.com/JetBrains/teamcity-cli/releases/latest/download/teamcity_linux_amd64.deb
sudo dpkg -i teamcity_linux_amd64.deb

RHEL/Fedora:

sudo rpm -i https://github.com/JetBrains/teamcity-cli/releases/latest/download/teamcity_linux_amd64.rpm

Arch Linux (AUR):

yay -S teamcity-bin

PowerShell:

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

CMD:

curl -fsSL https://jb.gg/tc/install.cmd -o install.cmd && install.cmd && del install.cmd

Chocolatey:

choco install teamcitycli

Scoop:

scoop bucket add jetbrains https://github.com/JetBrains/scoop-utils
scoop install teamcity

Build from source:

go install github.com/JetBrains/teamcity-cli/tc@latest

See the getting started guide for the full walkthrough.

Quick start

# Authenticate with your TeamCity server
teamcity auth login

# List recent builds
teamcity run list --limit 10

# List your favorite builds
teamcity run list --favorites --limit 10

# List my latest build for the current branch
teamcity run list --user @me --branch @this --limit 1

# 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

Note: The CLI uses "run" for builds and "job" for build configurations. See the glossary for the full mapping.

Commands

Group	Commands
auth	`login`, `logout`, `status`
run	`list`, `start`, `view`, `watch`, `log`, `tree`, `changes`, `tests`, `diff`, `cancel`, `download`, `artifacts`, `restart`, `pin`/`unpin`, `tag`/`untag`, `comment`
job	`list`, `view`, `tree`, `pause`/`resume`, `param list`/`get`/`set`/`delete`
project	`list`, `view`, `create`, `tree`, `vcs list`/`view`/`create`/`test`/`delete`, `ssh list`/`generate`/`upload`/`delete`, `cloud profile`/`image`/`instance`, `connection list`/`create github-app`/`create docker`/`authorize`/`delete`, `param`, `token get`/`put`, `settings export`/`status`/`validate`
pipeline	`list`, `view`, `create`, `validate`, `pull`, `push`, `schema`, `delete`
queue	`list`, `approve`, `remove`, `top`
agent	`list`, `view`, `term`, `exec`, `jobs`, `authorize`/`deauthorize`, `enable`/`disable`, `move`, `reboot`
pool	`list`, `view`, `link`/`unlink`
api	Raw REST API access
link	Bind this repository to a TeamCity project via `teamcity.toml`
config	`list`, `get`, `set`
alias	`set`, `list`, `delete`
skill	`list`, `install`, `remove`, `update`
update	Check for CLI updates

Run teamcity <command> --help for usage details. See the command reference for full documentation.

For AI agents

An Agent Skill is included with teamcity. It teaches AI coding agents how to use teamcity for common TeamCity workflows.

teamcity skill install           # auto-detects installed agents (Claude Code, Cursor, etc.)
teamcity skill install --project # install to current project only
teamcity skill update            # update to latest version bundled with teamcity
teamcity skill remove            # uninstall

or specifically for Claude Code:

/plugin marketplace add JetBrains/teamcity-cli
/plugin install teamcity-cli@teamcity-cli

See AI agent integration for details.

Learn more

Getting started – install, authenticate, and run your first commands
Configuration – config file, environment variables, multi-server setup, shell completion
Scripting and automation – JSON output, plain text mode, CI/CD integration
Aliases – create custom command shortcuts

Contributing

TeamCity CLI is open source under the Apache-2.0 license. Contributions are welcome – see CONTRIBUTING.md for setup instructions and guidelines.

License

Apache-2.0