teamcity-cli について
TeamCity のビルド、ジョブ、プロジェクト、エージェント、キュー、パイプラインを管理するコマンドラインツールです。障害調査やパイプライン操作に対応し、診断とサーバー設定のコマンドも案内します。
主な機能
- 01実行の一覧表示・開始・監視・確認
- 02ログ、テスト、成果物、ビルドツリーの参照
- 03ジョブ、プロジェクト、エージェント、キューの管理
- 04パイプラインの作成・検証・プッシュ
- 05TeamCity REST API へのアクセス
活用シーン
- 01失敗したビルドの調査
- 02ビルドチェーン内の障害追跡
- 03ビルドの開始と監視
- 04パイプライン変更の検証
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ jetbrains/ teamcity-skills --skill teamcity-cliインストール後、Claude Code で/teamcity-cliを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
embed.goplugin_agent_test.go_agents/babysit-build.mdreferences/commands.mdoutput.mdworkflows.mdreferences/workflows/agents.mdartifacts.mdbuild-metadata-and-queue.mdconnections-and-vcs.mdfind-jobs-projects.mdfix-and-verify.mdinspect-from-url.mdinvestigate-failure.mdkotlin-dsl.mdparameters.mdpipelines.mdproject-settings-and-tokens.mdrun-builds.mdtest-reliability.mdtroubleshooting.md詳細
TeamCity CLI(teamcity)
クイックスタート
teamcity auth status # Check authentication
teamcity run list --status failure # Find failed builds
teamcity run log <id> --failed --raw # Full failure diagnostics
フラグや構文を推測しないでください。 コマンドリファレンスまたはteamcity <command> --helpを使用してください。ビルドは実行(teamcity run)、ビルド構成はジョブ(teamcity job)です。--countは使用せず、--limit(または-n)を使用してください。
注意点
- 複合ビルドのログは空です — 実際の失敗を確認するには、子ビルドを調べてください。
- ビルドチェーンは末端から失敗します — 最も深い階層で失敗した依存関係が根本原因です。
teamcity run tree <id>を使用してください。 --local-changesはKotlin DSLを除外します — 実行前に.teamcity/の変更をプッシュしてください。TEAMCITY_URLでコマンドごとにサーバーを選択します —TEAMCITY_URL=https://cli.teamcity.com teamcity run listは、そのサーバーに保存された認証情報を使用します。上書きするにはTEAMCITY_TOKENを設定してください。- 読み取り専用モードではリモートシェルがブロックされます —
TEAMCITY_RO=1またはサーバーごとのro: trueを設定すると、接続前にagent execとagent termが拒否されます。 - 複数ルートの実行:
--revision ROOT=SHA[@BRANCH]を繰り返します。ROOT=@BRANCHは取得済みのブランチヘッドを使用します。SHAのみを指定すると、すべてのルートがそのSHAに固定されます。 - ログ:
--rawを使用して一時ファイルに出力します。ビルド:開始時には--watchを使用してください。 - VCSトリガーが常に設定されているとは限りません — 修正をプッシュした後、手動でビルドを開始する必要がある場合があります。
pipeline pushは検証を行いません — 必ず先にteamcity pipeline validateを実行してください。- GitHub VCSルートではGitHub App接続を使用してください。
--auth passwordでPATを貼り付けないでください。ワークフローを参照してください。
主なコマンド
オリジンをまたぐダウンロードではリクエストヘッダーが削除されます。HTTPSのダウングレードと、オリジンをまたぐターミナルのリダイレクトは拒否されます。
| 領域 | コマンド |
|---|---|
| 認証 | auth login、logout、status |
| ビルド | run list、view、start、watch、log、cancel、restart、tests、changes、tree |
| アーティファクト | run artifacts、run download |
| メタデータ | run pin/unpin、run tag/untag、run comment |
| ジョブ | job list、view、create、tree、pause/resume、step list/view/add/delete、param list/get/set/delete、settings list/get/set |
| プロジェクト | project list、view、create、tree、param、token put/get、settings export/status/enable |
| VCS/接続 | project vcs list/view/create/delete、project connection list/create/authorize/delete |
| キュー | queue list、approve、remove、top |
| エージェント | agent list、view、enable/disable、authorize/deauthorize、exec、term、reboot、move |
| プール | pool list、view、link/unlink |
| サーバー | server plugin upload(--hot-reloadを任意で指定) |
| パイプライン | pipeline list、view、create、validate、pull、push、schema、delete |
| API | teamcity api <endpoint> — RESTへの直接アクセス |
| リンク | teamcity link — teamcity.tomlを使ってリポジトリを紐付ける |
クイックワークフロー
アーティファクトのダウンロードは --output の範囲内にとどまります。ディレクトリから外に抜けるシンボリックリンクは拒否され、転送に失敗しても既存のファイルは保持されます。
各項目の詳細については、ワークフローを参照してください。
- 失敗を調査する:
run list --status failure→run log <id> --failed --raw→run tests <id> --failed - ビルドチェーンをデバッグする:
run tree <id>→ 最も深い階層にある失敗した子を調べる - 修正して検証する:編集 → プッシュ →
run start --watch(個人用ビルドでは--local-changesを使用) - パイプラインのライフサイクル:
pipeline pull <id>→ 編集 →pipeline validate→pipeline push <id>。pipeline schemaを実行すると、サーバーから有効なランナーと機能を含む完全なスキーマを取得できます - GitHub VCS:
connection create github-app→connection authorize→ リポジトリに App をインストール →vcs create --auth token --connection-id <id> - Docker レジストリ:
echo $TOKEN | connection create docker -p <id> --name X --url https://ghcr.io --username U --stdin
リファレンス
- コマンドリファレンス — すべてのコマンドとフラグ
- ワークフロー — タスクごとの詳細なワークフロードキュメントの一覧(失敗の調査、ビルドチェーン、接続、パイプラインなど)
- 出力形式 — JSON、プレーンテキスト、スクリプト作成
project settings status は、サーバーのランタイムメッセージと不足している DSL コンテキストパラメーターを報告します。「Recorded」のタイムスタンプはステータスが記録された時刻であり、最後に同期が成功した時刻ではありません。
コメント
Markdown 対応