構成

このページでは、TeamCity CLI の 設定 コマンド、構成ファイルフォーマット、環境変数、シェル補完設定について説明します。

`teamcity config` による構成の管理

設定 コマンドを使用すると、YAML ファイルを直接編集することなく、CLI 設定を表示および変更できます。

すべての設定を一覧表示

teamcity config list
teamcity config list --json

設定を取得する

teamcity config get default_server
teamcity config get ro --server tc.example.com

設定値を設定する

# Switch default server
teamcity config set default_server tc.example.com

# Enable read-only mode for a specific server
teamcity config set ro true --server tc.example.com

# Enable guest auth for the default server
teamcity config set guest true

   

利用可能な鍵

キー	スコープ	説明
`default_server`	グローバル	デフォルトの TeamCity サーバー URL。
`guest`	サーバーごと	ゲスト認証を有効にします（トークンは不要です）。特定のサーバーを対象とするには、 `--server` を使用します。
`ro`	サーバーごと	読み取り専用モードを有効にします（すべての書き込み操作をブロックします）。特定のサーバーを対象とするには、 `--server` を使用します。
`token_expiry`	サーバーごと	トークンの有効期限タイムスタンプ（RFC 3339）。通常は `auth login` によって設定されます。
`analytics`	グローバル	匿名の使用箇所統計を有効化または無効化します。デフォルト: `真`。オプトアウトするには `偽` に設定します。

認証フィールド（token、 user ）は teamcity auth login/teamcity auth logout によって管理されており、 config set 経由で設定することはできません。

構成ファイル

TeamCity CLI は構成を ~/.config/tc/config.yml の YAML ファイルに保存します。このファイルは teamcity auth login を実行すると自動的に作成されます。

一般的な構成ファイルは次のようになります。

default_server: https://teamcity.example.com
servers:
  https://teamcity.example.com:
    user: alice
  https://teamcity-staging.example.com:
    user: alice
    guest: true
  https://teamcity-prod.example.com:
    user: alice
    ro: true
aliases:
  rl: 'run list'
  rw: 'run view $1 --web'
  mine: 'run list --user=@me'

  

構成フィールド

フィールド	説明
`default_server`	`TEAMCITY_URL` 環境変数が設定されていない場合に使用されるサーバー URL。 `teamcity auth login` を実行すると自動的に更新されます。
`サーバー`	サーバーの URL とその設定をマッピングしたファイルです。各エントリには、 `user` フィールド（そのサーバー上のユーザー名）が格納され、オプションでゲストアクセス用の `guest: true` 、読み取り専用モード用の `ro: true` も格納されます。トークンは、ログイン時に `--insecure-storage` が使用されない限り、このファイルではなくシステムキーリングに保存されます。
`aliases`	エイリアス名とその展開のマップ。詳細はエイリアスを参照してください。

環境変数

環境変数は構成ファイルの設定をオーバーライドするため、CI/CD パイプラインで CLI を構成するための推奨される方法です。

変数	説明
`TEAMCITY_URL`	TeamCity サーバー URL。設定ファイルでは `default_server` よりも優先されます。
`TEAMCITY_TOKEN`	認証用のアクセストークン。キーリングおよび設定ファイルトークンよりも優先されます。
`TEAMCITY_GUEST`	ゲスト認証（読み取り専用、トークン不要）を使用するには、 `1` に設定します。 CLI は、（`TEAMCITY_URL` 、DSL 検出、または設定ファイルを介して）サーバー URL を解決できる必要があります。
`TEAMCITY_RO`	読み取り専用モードを有効にするには、 `1`、 `真` 、または `yes` に設定します。有効化されている場合、GET 以外のすべての API リクエスト (POST、PUT、DELETE) がブロックされ、TeamCity サーバーへの変更が防止されます。スクリプトやダッシュボードの監視に便利です。設定ファイルで `ro: true` を使用してサーバーごとに設定することもできます。
`TEAMCITY_DSL_DIR`	Kotlin DSL ディレクトリへのパス。 `.teamcity/` または `.tc/` ディレクトリの自動検出をオーバーライドします。
`NO_COLOR`	カラー出力を無効にします。 NO_COLOR 標準(英語)に準拠します。
`TEAMCITY_NO_COLOR`	カラー出力を無効にするための、 `NO_COLOR` に代わるアプリ固有の代替手段。
`TEAMCITY_NO_UPDATE`	自動更新チェックを無効にするには、 `1`、 `真`、 `yes` に設定してください。更新チェックは、CI 環境および非対話型ターミナルでも自動的に無効になります。
`TEAMCITY_HEADER_*`	送信するすべてのリクエストに HTTP ヘッダーを追加します。サフィックスは、アンダースコアをハイフンに変換し、正規の大文字小文字表記にしたヘッダー名になります: `TEAMCITY_HEADER_FOO_BAR=baz` は `Foo-Bar: baz` を送信します。空の値は無視されます。CR/LF/NUL を含む値は、ヘッダーインジェクションを防ぐために破棄されます。ヘッダー値は `--verbose` の出力でマスクされます。
`DO_NOT_TRACK`	匿名使用統計を無効にするには、 `1`、 `真`、 `yes` または `on` に設定してください。業界標準(英語)に準拠しています。 `TEAMCITY_ANALYTICS` および設定ファイルよりも優先されます。
`TEAMCITY_ANALYTICS`	`0`、 `偽`、 `no` または `off` に設定すると、この CLI の匿名使用統計が無効になります。設定ファイルよりも優先されます。

例:

export TEAMCITY_URL="https://teamcity.example.com"
export TEAMCITY_TOKEN="your-access-token"

PowerShell:

$env:TEAMCITY_URL = "https://teamcity.example.com"
$env:TEAMCITY_TOKEN = "your-access-token"

Cmd:

set TEAMCITY_URL=https://teamcity.example.com
set TEAMCITY_TOKEN=your-access-token

TERM=dumb を設定すると、カラー出力も無効になります。出力先がターミナルでない場合（たとえば、別のコマンドにパイプする場合など）、カラー出力は自動的に無効になります。

追加の HTTP ヘッダー (企業プロキシ)

TeamCity サーバーが Cloudflare Access や Google IAP などの認証プロキシの背後にある場合、プロキシではすべてのリクエストで独自の資格情報が必要です。 TEAMCITY_HEADER_* では、設定ファイルを編集することなく、環境変数を介して認証情報を提供できます。 CLI は、すべての API 呼び出し、認証ログインプローブ、PKCE 交換、エージェントターミナル WebSocket など、リクエストがプロキシを通過する可能性のあるあらゆる場所に認証情報を適用します。

ヘッダー名は以下のルールに従います。

接頭辞の後に続く接尾辞は大文字になり、アンダースコアはハイフンになり、結果として正規の大文字小文字の形式になります。
TEAMCITY_HEADER_CF_ACCESS_CLIENT_ID=value → Cf-Access-Client-Id: value.
空の値はスキップされます。 CR/LF/NUL を含む値は破棄されます。
ヘッダー名に関わらず、 --verbose の出力では値が伏せ字化されます。

Cloudflare Access サービストークン

export TEAMCITY_HEADER_CF_ACCESS_CLIENT_ID="abc123.access"
export TEAMCITY_HEADER_CF_ACCESS_CLIENT_SECRET="$(cat ~/.cf-access-secret)"
teamcity run list

    

Google IAP

IAP には、サービスアカウントによって署名された最新の ID トークンが必要です。小さなラッパーがトークンを最新の状態に保ちます。

teamcity-iap() {
  export TEAMCITY_HEADER_PROXY_AUTHORIZATION="Bearer $(gcloud auth print-identity-token --audiences=$IAP_AUDIENCE)"
  teamcity "$@"
}

teamcity-iap run list

    

リポジトリスコープの構成では、これらを direnv.envrc に設定し、プロジェクトディレクトリに cd したときにのみ存在するようにします。

グローバルフラグ

これらのフラグはすべてのコマンドで使用できます。

フラグ	説明
`-h`, `--help`	コマンドのヘルプを表示します。
`-v`, `--version`	CLI バージョンを表示します。
`--no-color`	カラー出力を無効にします。
`-q`, `--quiet`	不要な出力を抑制します。 `--verbose` とは同時に実行できません。
`--verbose`	デバッグ情報を含む詳細な出力を表示します。 `--quiet` とは同時に実行できません。
`--no-input`	対話型プロンプトを無効にします。 CLI は、プロンプトが表示される場合、適切なデフォルトを使用します。

シェル補完

TeamCity CLI は、Bash、Zsh、Fish、PowerShell のタブ補完をサポートしています。補完対象は、コマンド、サブコマンド、フラグ、場合によってはプロジェクト ID やジョブ ID などの値です。

teamcity completion bash > /etc/bash_completion.d/teamcity

/etc/bash_completion.d/ への書き込みアクセス権がない場合は、ユーザーレベルの場所に書き込み、 .bashrc からソースを取得します。

teamcity completion bash > ~/.teamcity-completion.bash
echo 'source ~/.teamcity-completion.bash' >> ~/.bashrc

teamcity completion zsh > "${fpath[1]}/_teamcity"

~/.zshrc に compinit が含まれていることを確認してください。

autoload -Uz compinit && compinit

teamcity completion fish > ~/.config/fish/completions/teamcity.fish

teamcity completion powershell > teamcity.ps1
. ./teamcity.ps1

補完機能を自動的に読み込むには、出力結果を PowerShell プロファイルに追加してください。

2026 年 9 月 11 日

構成

teamcity config による構成の管理