コマンドラインユーティリティ

SSH 管理ユーザとしてサインインした後では、VM 上のどこからでもこれらのコマンドを実行できます。詳細については、「管理シェル (SSH) にアクセスする」を参照してく� さい。

全般

ghe-announce

このユーティリティは、あらゆる GitHub Enterprise ページの上部にバナーを設定します。これを使用すればユーザにメッセージを配信することができます。

# Sets a message that's visible to everyone
$ ghe-announce -s MESSAGE
> Announcement message set.
# Removes a previously set message
$ ghe-announce -u
> Removed the announcement message

GitHub Enterprise Server のエンタープライズ設定を使用して、お知らせバナーを設定することもできます。詳細については、インスタンスでのユーザーメッセージのカスタマイズに関する記事を参照してく� さい。

ghe-aqueduct

このユーティリティは、アクティブなものとキュー内にあるもの両方のバックグラウンドジョブに関する情� �を表示します。これは、すべてのページの上部にある管理統計バーと同じジョブ数を表示します。

このユーティリティは、Aqueduct サーバーでバックグラウンドジョブの処理に問題があるかどうかを識別するのに役立ちます。以下のどのシナリオも Aqueduct の問題を示している可能性があります。

背景のジョブの数が増えていますが、実行中のジョブの数は同じままです。
イベントフィードが更新されない。
webhook はトリガーされていません。
Git プッシュ後、ウェブインタフェースが更新されない。

Aqueduct の故障を懸念している� �合は、GitHub Enterprise Support に連絡してく� さい。

このコマンドでは、キューでのジョブ停止または再開をすることができます。

$ ghe-aqueduct status
# lists queues and the number of currently queued jobs for all queues
$ ghe-aqueduct queue_depth --queue QUEUE
# lists the number of currently queued jobs for the specified queue
$ ghe-aqueduct pause --queue QUEUE
# pauses the specified queue
$ ghe-aqueduct resume --queue QUEUE
# resumes the specified queue

ghe-check-disk-usage

このユーティリティは、大きなファイルがないか、あるいは削除されているがファイルハンドルがま� 開いているファイルがないか、ディスクをチェックします。これは、ルートパーティションで空き容量を確保しようとしているときに実行してく� さい。

ghe-check-disk-usage

ghe-cleanup-caches

このユーティリティは、ルートボリュー� でディスク� �域を将来余分に取り過ぎる可能性があるさまざまなキャッシュをクリーンアップします。ルートボリュー� のディスク� �域の使用量が時間の経過とともに著しく増� していることがわかった� �合は、このユーティリティを実行して全体的な使用量を減らすのに役立つかどうかを確認することをおすすめします。

ghe-cleanup-caches

ghe-cleanup-settings

このユーティリティは、既存の [Management Console] の設定をすべて消去します。

ヒント: 通常、これを実行するのは、サポートに連絡し、サポートからそうするように依� �された� �合� けです。

ghe-cleanup-settings

ghe-config

このユーティリティを使用すると、your GitHub Enterprise Server instanceの設定を取得して変更することができます。

$ ghe-config core.github-hostname
# Gets the configuration value of `core.github-hostname`
$ ghe-config core.github-hostname URL
# Sets the configuration value of `core.github-hostname` to the specified URL
$ ghe-config -l
# Lists all the configuration values

cluster.conf でノードのユニバーサル一意識別子 (UUID) を見つけることができます。

$ ghe-config HOSTNAME.uuid

REST API レート制限からユーザーの一覧を除外できます。これらのユーザーには、120,000 件の要求のハード制限が引き続き適用されます。詳細については、「REST API のリソース」を参照してく� さい。

$ ghe-config app.github.rate-limiting-exempt-users "HUBOT GITHUB-ACTIONS"
# Exempts the users hubot and github-actions from rate limits

ghe-config-apply

このユーティリティは、[Management Console] の設定の適用や、システ� サービスのリロード、アプリケーションサービスのリロード、保留中のデータベースマイグレーションを行います。これは、[Management Console] の Web UI で [設定の保存] をクリックするか、/setup/api/configure エンドポイントに POST 要求を送信するのと同じです。

手動で実行することはないと思いますが、設定を保存する過程をSSH 経由で自動化したい� �合に利用できます。

ghe-config-apply

ghe-console

このユーティリティは、GitHub Enterprise アプライアンスで GitHub Rails コンソールを開きます。このコマンドは、GitHub Enterprise サポートからの指示がない� �合は 使用しないでく� さい。間違った利用は、ダメージやデータの損失を招くことがあります。

ghe-console

ghe-dbconsole

このユーティリティは、GitHub Enterprise アプライアンスで MySQL データベースセッションを開きます。このコマンドは、GitHub Enterprise サポートからの指示がない� �合は 使用しないでく� さい。間違った利用は、ダメージやデータの損失を招くことがあります。

ghe-dbconsole

ghe-es-index-status

このユーティリティは、ElasticSearch のインデックスの概要を CSV フォーマットで表示します。

STDOUT でヘッダー行が付いているインデックスの概要を表示します。

$ ghe-es-index-status -do
> warning: parser/current is loading parser/ruby23, which recognizes
> warning: 2.3.3-compliant syntax, but you are running 2.3.4.
> warning: please see https://github.com/whitequark/parser#compatibility-with-ruby-mri.
> Name,Primary,Searchable,Writable,UpToDate,RepairProgress,Version
> code-search-1,true,true,true,true,100.0,72e27df7c631b45e026b42bfef059328fa040e17
> commits-5,true,true,true,true,100.0,7ed28813100c47813ef654c0ee2bb9abf21ab744
> gists-4,true,true,true,true,100.0,cf8e7d04fcf2564c902e2873c424a279cc41079d
> issues-4,false,false,false,true,100.0,d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> issues-5,true,true,true,true,100.0,d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> projects-2,true,true,true,true,100.0,c5cac1c4b3c66d42e609d088d174dbc3dd44469a
> pull-requests-6,true,true,true,true,100.0,6a466ad6b896a3499509990979bf9a18d7d41de3
> repos-6,true,true,true,true,100.0,6c8b5fbba0fc1e409558db411d05e092c1387082
> users-5,true,true,true,true,100.0,38984875552bb826c9ec42999f409cb2e95556eb
> wikis-4,true,true,true,true,100.0,2613dec44bd14e14577803ac1f9e4b7e07a7c234

インデックスの概要を表示し、読みやすくするために結果を column にパイプします。

$ ghe-es-index-status -do | column -ts,
> warning: parser/current is loading parser/ruby23, which recognizes
> warning: 2.3.3-compliant syntax, but you are running 2.3.4.
> warning: please see https://github.com/whitequark/parser#compatibility-with-ruby-mri.
> Name             Primary  Searchable  Writable  UpToDate  RepairProgress  Version
> code-search-1    true     true        true      true      100.0           72e27df7c631b45e026b42bfef059328fa040e17
> commits-5        true     true        true      true      100.0           7ed28813100c47813ef654c0ee2bb9abf21ab744
> gists-4          true     true        true      true      100.0           cf8e7d04fcf2564c902e2873c424a279cc41079d
> issues-4         false    false       false     true      100.0           d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> issues-5         true     true        true      true      100.0           d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> projects-2       true     true        true      true      100.0           c5cac1c4b3c66d42e609d088d174dbc3dd44469a
> pull-requests-6  true     true        true      true      100.0           6a466ad6b896a3499509990979bf9a18d7d41de3
> repos-6          true     true        true      true      100.0           6c8b5fbba0fc1e409558db411d05e092c1387082
> users-5          true     true        true      true      100.0           38984875552bb826c9ec42999f409cb2e95556eb
> wikis-4          true     true        true      true      100.0           2613dec44bd14e14577803ac1f9e4b7e07a7c234

ghe-legacy-github-services-report

このユーティリティは、2018 年 10 月 1 日に廃止予定の統合方式である GitHub サービスを使用しているアプライアンス上のリポジトリを一覧表示します。アプライアンス上のユーザーは、特定のリポジトリへのプッシュに対する通知を作成するために、GitHub サービスを設定している� �合があります。詳細については、the GitHub Blog の「GitHub サービスの非推奨の発表」または「GitHub サービスの置き換え」を参照してく� さい。このコマンドの詳細や追� のオプションについては、-h フラグを使用してく� さい。

ghe-legacy-github-services-report

ghe-logs-tail

このユーティリティでは、インストールから関連するすべてのログファイルを末尾に記録できます。オプションを渡すことでログを特定のセットに制限できます。追� オプションを確認するには -h フラグを使用してく� さい。

ghe-logs-tail

ghe-maintenance

このユーティリティにより、インストールのメンテナンスモードの状態を制御できます。これは主に舞台裏で [Management Console] によって使用されるように設計されていますが、直接使用することもできます。詳細については、「メンテナンスモードの有効化とスケジューリング」を参照してく� さい。

ghe-maintenance -h

ghe-motd

このユーティリティは、管理者が管理シェルを介してインスタンスにアクセスしたときに表示される今日のメッセージ (MOTD) を再表示します。出力には、インスタンスの状態の概要が含まれます。

ghe-motd

ghe-nwo

このユーティリティを使って、リポジトリの ID でリポジトリの名前とオーナーを検索することができます。

ghe-nwo REPOSITORY_ID

ghe-org-admin-promote

このコマンドを使用して、アプライアンスでサイトの管理者権限を持つユーザーに Organization のオーナー権限を付与したり、単一の Organization 内の任意の単一ユーザーに Organization のオーナー権限を付与したりします。ユーザーや Organization を指定する必要があります。 -y フラグを使って確認を回避しない限り、ghe-org-admin-promote コマンドは実行前に常に確認を求めます。

ユーティリティでは以下のオプションを使用できます。

-u フラグはユーザー名を指定します。このフラグを使用して特定ユーザーに Organization のオーナー権限を付与します。すべてのサイト管理者を指定された組織に昇� �させるため、-u フラグを省略します。
-o フラグは組織を指定します。このフラグを使用して特定の Organization でオーナー権限を付与します。指定されたサイト管理者にすべての組織のオーナー権限を付与するには、-o フラグを省略します。
-a のフラグは、すべてのサイト管理者にすべての組織のオーナー権限を与えます。
-y フラグは手動の確認を回避します。

このユーティリティは、非サイト管理者をすべての Organization のオーナーに昇� �させることはできません。 ghe-user-promote を使用すれば、通常のユーザーアカウントをサイト管理者に昇� �させることができます。

特定の Organization の Organization のオーナーの権限を特定のサイト管理者に与える

ghe-org-admin-promote -u USERNAME -o ORGANIZATION

全ての Organization で特定のサイトアドミンに Organizationのオーナー権限を与える

ghe-org-admin-promote -u USERNAME

特定の Organization で全てのサイトアドミンに Organizationのオーナー権限を与える

ghe-org-admin-promote -o ORGANIZATION

全ての Organization で全てのサイトアドミンに Organization のオーナー権限を与える

ghe-org-admin-promote -a

このコマンドを使用して、10 分間でログイン試行が 10 回失敗しました。

$ ghe-reactivate-admin-login

ghe-saml-mapping-csv

このユーティリティは、SAMLレコードのマップを支援します。

GitHub Enterprise ServerユーザのためのすべてのSAMLマッピングを含むCSVファイルを作成するには、次のようにします。

$ ghe-saml-mapping-csv -d

新しい値でのSAMLマッピングの更新のドライランを実行するには、次のようにします。

$ ghe-saml-mapping-csv -u -n -f /path/to/file

新しい値でSAMLマッピングを更新するには、次のようにします。

$ ghe-saml-mapping-csv -u -f /path/to/file

ghe-service-list

このユーティリティは、アプライアンスに開始または停止された（実行中または待機中）、全てのサービスの一覧を表示します。

$ ghe-service-list

start/running
  - github-resqued, process 12711
  - github-unicorn, process 12726
  - github-gitauth, process 12743
  - git-daemon, process 12755
  - babeld, process 12771
  - github-svn-proxy, process 12802
  - gist-unicorn, process 12832
  - gist-resqued, process 12881
  - render-unicorn, process 12939
  - hookshot-unicorn, process 13076
  - nodeload2, process 13192
  - slumlord-unicorn, process 13304
  - ghe-storage, process 2012
  - enterprise-manage-unicorn, process 2024
  - enterprise-manage-resque, process 2053
stop/waiting
  - ghe-replica-mode

ghe-set-password

ghe-set-password を使用すると、[Management Console] に対して認証するための新しいパスワードを設定できます。

ghe-set-password

ghe-setup-network

このユーティリティを使用すると、プライマリネットワークインターフェイスを構成できます。

ビジュアルモードを開始するための、ネットワーク設定の構成について説明します。

$ ghe-setup-network -v

追� オプションを確認するには -h フラグを使用してく� さい。

ghe-ssh-check-host-keys

このユーティリティは、既存の SSH のホストキーを漏洩した SSH ホストキーと比べます。

$ ghe-ssh-check-host-keys

漏洩したホストキーが発見された� �合、ユーティリティは状態 1 と次のメッセージで終了します。

> One or more of your SSH host keys were found in the blacklist.
> Please reset your host keys using ghe-ssh-roll-host-keys.

漏洩したホストキーが発見されなかった� �合、ユーティリティは状態 0 と次のメッセージで終了します。

> The SSH host keys were not found in the SSH host key blacklist.
> No additional steps are needed/recommended at this time.

ghe-ssh-roll-host-keys

このユーティリティは、SSH のホストキーを廃棄し、新しく作成したキーに置き換えます。

$ sudo ghe-ssh-roll-host-keys
Proceed with rolling SSH host keys? This will delete the
existing keys in /etc/ssh/ssh_host_* and generate new ones. [y/N]

# Press 'Y' to confirm deleting, or use the -y switch to bypass this prompt

> SSH host keys have successfully been rolled.

ghe-ssh-weak-fingerprints

このユーティリティは、GitHub Enterprise のアプライアンスに保存されている脆弱なSSHキーの� �告を作成します。ユーザのキーを一括アクションとして取り消すことができます。このユーティリティは弱いシステ� キーを� �告します。[Management Console] でこのキーを手動で取り消す必要があります。

# Print a report of weak user and system SSH keys
$ ghe-ssh-weak-fingerprints

# Revoke all weak user keys
$ ghe-ssh-weak-fingerprints --revoke

ghe-ssl-acme

このユーティリティでは、 GitHub Enterprise のアプライアンスに Let's Encrypt の証明書をインストールすることができます。詳細については、「TLS の構成」を参照してく� さい。

-x フラグを使って、ACME 構成を削除できます。

ghe-ssl-acme -e

ghe-ssl-ca-certificate-install

このユーティリティでは、GitHub Enterprise のサーバにカスタ� ルートのCA証明書をインストールできます。証明書は PEM 形式でなければなりません。さらに、証明書プロバイダーが 1 つのファイルに複数の CA 証明書を含めている� �合は、それらを個別のファイルに分けて ghe-ssl-ca-certificate-install に一度に 1 つずつ渡す必要があります。

S/MIME コミット署名の検証のために証明書チェーンを追� するには、このユーティリティを実行します。詳細については、「コミット署名の検証について」を参照してく� さい。

他のサーバーが自己署名 SSL 証明書または必要な CA バンドルがついていない SSL 証明書を使っているため your GitHub Enterprise Server instanceがそのサーバーに接続できない� �合、このユーティリティを実行します。これを確認する 1 つの方法は、your GitHub Enterprise Server instanceから openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs を実行することです。リモートサーバーの SSL 証明書を確認できたら、SSL-Session が次のように 0 のリターンコードを表示します。

SSL-Session:
    Protocol  : TLSv1
    Cipher    : AES128-SHA
    Session-ID: C794EBCC3CBC10F747C9AFC029C03C1048FC99CFC34D13D7444E0F267C58DF4C
    Session-ID-ctx:
    Master-Key: 02A7C47CFD6EEC87D3C710E9DD87390E04EF82DDD7514AE03127D5DC1945FC0CAEFB5395791AEA598667EFA61B9EA8C5
    Key-Arg   : None
    Start Time: 1394581597
    Timeout   : 300 (sec)
    Verify return code: 0 (ok)

反対に、リモートサーバーの SSL 証明書を確認 "できない" � �合は、SSL-Session が 0 ではないリターンコードを表示します。

SSL-Session:
    Protocol  : TLSv1
    Cipher    : AES128-SHA
    Session-ID: 82CB288051A6DB66094C50A69CF1292AEE7E54C6B01B659B98AB336F8C33863E
    Session-ID-ctx:
    Master-Key: 01B025B2F764043A27919A8D1355AAECD8844FF0831B1D664042334790574A6F4025BAB085D4ED71D71AAB3091B849E5
    Key-Arg   : None
    Start Time: 1394581782
    Timeout   : 300 (sec)
    Verify return code: 27 (certificate not trusted)

ユーティリティでは以下のオプションを使用できます:

-r フラグにより、CA 証明書をアンインストールできます。
-h フラグはさらなる使用情� �を表示します。

ghe-ssl-ca-certificate-install -c CERTIFICATE_PATH

ghe-ssl-certificate-setup

このユーティリティを使用すると、your GitHub Enterprise Server instanceの SSL 証明書を更新できます。

このコマンドの詳細や追� のオプションについては、-h フラグを使用してく� さい。

ghe-ssl-certificate-setup

ghe-ssl-generate-csr

このユーティリティにより、秘密鍵と証明書署名要求 (CSR) を生成できます。これらを商用またはプライベートの認証局と共有することで、インスタンスで使用する有効な証明書を取得できます。詳細については、「TLS の構成」を参照してく� さい。

このコマンドの詳細や追� のオプションについては、-h フラグを使用してく� さい。

ghe-ssl-generate-csr

ghe-storage-extend

一部のプラットフォー� では、ユーザボリュー� を拡張するためにこのスクリプトが必要です。詳細については、「ストレージ容量の増� 」を参照してく� さい。

$ ghe-storage-extend

ghe-version

このユーティリティによって、your GitHub Enterprise Server instanceのバージョン、プラットフォー� 、およびビルドが表示されます。

$ ghe-version

ghe-webhook-logs

このユーティリティは、管理人がレビューして問題を突き止めるための webhook のデリバリログを表示します。

ghe-webhook-logs

過去 1 日の失敗したすべてのフックデリバリーを表示するには、以下を使用します:

ghe-webhook-logs -f -a YYYY-MM-DD

日付の形式は、YYYY-MM-DD、YYYY-MM-DD HH:MM:SS、または YYYY-MM-DD HH:MM:SS (+/-) HH:M である必要があります。

フックペイロードの全体、結果、およびデリバリーの例外を表示するには、以下を使用します:

ghe-webhook-logs -g DELIVERY_GUID

クラスタリング

ghe-cluster-status

GitHub Enterprise Server のクラスターデプロイメントでノードとサービスの健全性を確認します。

$ ghe-cluster-status

ghe-cluster-support-bundle

このユーティリティは、Geo-replication またはクラスタリングのいずれかの構成で、各ノードからの重要なログを含む Support Bundle tarball を作成します。

既定では、コマンドは /tmp に tarball を作成しますが、SSH 経由で簡単にストリーミングできるように tarball を STDOUT に cat させることもできます。これは、Web UI が反応していないか、 /setup/support からサポートバンドルをダウンロードできないときに役立ちます。より古いログを含む "拡張" バンドルを生成するときにこのコマンドを使う必要があります。さらに、このコマンドを使って GitHub Enterprise のサポートにクラスタリングSupport Bundle を直接アップロードすることができます。

標準のバンドルを作成するには、以下のようにします。

$ ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -o' > cluster-support-bundle.tgz

拡張バンドルを作成するには、以下のようにします。

$ ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -x -o' > cluster-support-bundle.tgz

バンドルをGitHub Supportに送信するには、以下のようにします。

$ ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -u'

バンドルをGitHub Supportに送信し、そのバンドルをチケットに関連づけるには以下のようにします。

$ ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -t TICKET_ID'

ghe-cluster-failover

アクティブクラスタノードからパッシブクラスタノードにフェイルオーバーします。詳細については、「レプリカクラスターへのフェールオーバーの開始」を参照してく� さい。

ghe-cluster-failover

ghe-dpages

このユーティリティを使えば、分散GitHub Pagesサーバーを管理できます。

ghe-dpages

リポジトリの� �所と健全性の概要を表示するには、以下のようにします。

ghe-dpages status

クラスタノードの退避に先立ってGitHub Pagesストレージサービスを退避するには、以下のようにします。

ghe-dpages evacuate pages-server-UUID

ghe-spokes

このユーティリティでは、分散型 Git サーバにある各リポジトリの3つのコピーを管理することができます。

ghe-spokes

リポジトリの� �所と健全性の概要を表示するには、以下のようにします。

ghe-spokes status

リポジトリが保存されているサーバーを表示するには、以下のようにします。

ghe-spokes route

クラスタノード上のストレージサービスを退避するには、以下のようにします。

ghe-spokes server evacuate git-server-UUID

ghe-storage

このユーティリティを使用すると、クラスタノードからの待避の前にストレージサービスをすべて待避させることができます。

ghe-storage evacuate storage-server-UUID

Git

ghe-btop

現在の Git 作業用の top にあたるインターフェイス。

ghe-btop [  | --help | --usage ]

ghe-governor

このユーティリティは、Git トラフィックの分析に役立ちます。これは、/data/user/gitmon 下にある "ガバナー" データファイルに対してクエリを実行します。 GitHub は、ファイルごとに 1 時間のデータを持ち、2 週間保持します。詳しくは、GitHub Community のガバナーを使用した Git トラフィックの分析に関する記事を参照してく� さい。

ghe-governor <subcommand> <column> [options]

ghe-governor -h
Usage: ghe-governor [-h] <subcommand> args

OPTIONS:
  -h | --help        Show this message.

Valid subcommands are:
  aggregate              Find the top (n) groups of queries for a grouping function and metric
  health                 Summarize all recent activity on one or more servers
  top                    Find the top (n) queries for a given metric
  dump                   Dump individual operations
  test-quotas            Check quota information

Try ghe-governor <subcommand> --help for more information on the arguments each subcommand takes.

ghe-repo

このユーティリティでは、リポジトリのディレクトリを変更し、git ユーザーとしてインタラクティブシェルを開くことができます。 git-* や git-nw-* などのコマンドを使って、手動でリポジトリの検査またはメンテナンスを行うことができます。

ghe-repo USERNAME/REPONAME

ghe-repo-gc

このユーティリティは、パックの容量を最適化するために、手動的にリポジトリのネットワークをリパックします。大きなリポジトリの� �合、このコマンドを実行するとリポジトリの全体的なサイズを減らすことができます。リポジトリのネットワークとの対話を通じて、GitHub Enterprise がこのコマンドを自動的に実行します。

省略可能な --prune 引数を追� して、ブランチ、タグ、またはその他の ref から参照されていない到達できない Git オブジェクトを削除できます。これは、以前に削除された機密情� �を直ちに削除する� �合に特に便利です。

警告: --prune 引数を使って到達できない Git オブジェクトを削除する前に、your GitHub Enterprise Server instanceをメンテナンスモードにするか、同じリポジトリネットワーク内のすべてのリポジトリがロックされていることを確認してく� さい。詳細については、「メンテナンスモードの有効化とスケジューリング」を参照してく� さい。

ghe-repo-gc USERNAME/REPONAME

GitHub Actions

ghe-actions-check

このユーティリティは、GitHub Actions のすべてのサービスが正常であることを確認します。詳細については、「GitHub Enterprise Server 用 GitHub Actions の概要」および「エンタープライズ用 GitHub Actions のトラブルシューティング」を参照してく� さい。

ghe-actions-check

ghe-actions-precheck

このユーティリティは、your GitHub Enterprise Server instance上の GitHub Actions の BLOB ストレージ構成をテストします。インスタンスに対して GitHub Actions を有効にする前に、このユーティリティを使用してストレージ構成を確認できます。

GitHub Actions の構成の詳細については、「GitHub Enterprise Server 用 GitHub Actions の概要」を参照してく� さい。

ghe-actions-precheck -p [PROVIDER] -cs ["CONNECTION-STRING"]

ストレージシステ� が正しく構成されている� �合は、次の出力が表示されます。

All Storage tests passed

インポートとエクスポート

ghe-migrator

ghe-migrator は、ある GitHub インスタンスから他に移行するために役立つハイファイツールです。インスタンスを統合、もしくは Organization やユーザ、Team、リポジトリをGitHub.comから GitHub Enterprise に移行することができます。

詳細については、「エンタープライズ間のデータ移行について」のガイドを参照してく� さい。

git-import-detect

URL が与えられたら、どのタイプのソース管理システ� が相手側にあるのかを検出します。このことは、手動インポートの間におそらくすでに知られていますが、自動化されたスクリプトでとても役立ちます。

git-import-detect

git-import-hg-raw

このユーティリティは、MercurialのリポジトリをこのGitリポジトリにインポートします。詳細については、「サードパーティのバージョン管理システ� からデータをインポートする」を参照してく� さい。

git-import-hg-raw

git-import-svn-raw

このユーティリティはSubversionの履歴とファイルデータをGitのブランチにインポートします。これはツリーの単純なコピーであり、トランクやブランチの区別を無視します。詳細については、「サードパーティのバージョン管理システ� からデータをインポートする」を参照してく� さい。

git-import-svn-raw

git-import-tfs-raw

このユーティリティは、Team Foundation Version Control (TFVC) からインポートします。詳細については、「サードパーティのバージョン管理システ� からデータをインポートする」を参照してく� さい。

git-import-tfs-raw

git-import-rewrite

このユーティリティは、インポートされたリポジトリを書き直します。これにより、作者名を変更したり、Subversion および TFVC では、フォルダーに基づいて Git ブランチがを生成したりすることができます。詳細については、「サードパーティのバージョン管理システ� からデータをインポートする」を参照してく� さい。

git-import-rewrite

サポート

ghe-diagnostics

このユーティリティは、さまざまな確認を行うとともに、インストールについての情� �を集めます。この情� �は、サポートチー� が問題の診断に役立てるために、送信することができます。

現在のところ、このユーティリティの出力は、[Management Console] で診断情� �をダウンロードすることに似ていますが、時間の経過とともに、Web UI では利用できない改善がさらに追� されている可能性があります。詳細については、「診断ファイルの作成と共有」を参照してく� さい。

ghe-diagnostics

ghe-support-bundle

注: geo レプリケーション構成または GitHub Enterprise クラスタリングを使用している� �合は、ghe-cluster-support-bundle コマンドを使用してサポートバンドルを取得する必要があります。詳細については、「コマンドラインユーティリティ」を参照してく� さい。

このユーティリティは、インスタンスからの重要なログを含むサポートバンドルの tarball を作成します。

既定では、コマンドは /tmp に tarball を作成しますが、SSH 経由で簡単にストリーミングできるように tarball を STDOUT に cat させることもできます。これは、Web UI が反応していないか、 /setup/support からサポートバンドルをダウンロードできないときに役立ちます。より古いログを含む "拡張" バンドルを生成するときにこのコマンドを使う必要があります。さらに、このコマンドを使って GitHub Enterprise のサポートに Support Bundle を直接アップロードすることができます。

標準のバンドルを作成するには、以下のようにします。

$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz

拡張バンドルを作成するには、以下のようにします。

$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -x -o' > support-bundle.tgz

バンドルをGitHub Supportに送信するには、以下のようにします。

$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -u'

バンドルをGitHub Supportに送信し、そのバンドルをチケットに関連づけるには以下のようにします。

$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -t TICKET_ID'

ghe-support-upload

このユーティリティは、アプライアンスから GitHub Enterprise サポートに情� �を送信します。ローカルファイルを指定、または STDIN 経由で最大 100MB までのストリー� を提供することができます。アップロードされたデータは任意でサポートチケットと関連付けることができます。

ファイルをGitHub Supportに送信し、そのファイルをチケットに関連づけるには以下のようにします。

ghe-support-upload -f FILE_PATH -t TICKET_ID

STDIN 経由でデータをアップロードし、そのデータをチケットに関連付けるには以下のようにします。

ghe-repl-status -vv | ghe-support-upload -t TICKET_ID -d "Verbose Replication Status"

この例では、ghe-repl-status -vv はレプリカアプライアンスから詳細な状態情� �を送信します。 ghe-repl-status -vvを STDIN にストリー� する特定のデータに置き換え、Verbose Replication Status をデータの簡単な説明に置き換える必要があります。通常、これを実行するのは、サポートに連絡し、サポートからそうするように依� �された� �合� けです。

GitHub Enterprise Server のアップグレード

ghe-upgrade

このユーティリティは、アップグレードパッケージをインストール、または確認します。アップグレードが失敗した� �合や中断された� �合は、このユーティリティを使用してパッチリリースをロールバックすることもできます。詳細については、「GitHub Enterprise Server のアップグレード」を参照してく� さい。

アップグレードパッケージを確認するには以下のようにします。

ghe-upgrade --verify UPGRADE-PACKAGE-FILENAME

アップグレードパッケージをインストールするには以下のようにします。

ghe-upgrade UPGRADE-PACKAGE-FILENAME

アップグレードをロールバックする� �合は、拡張子が .pkg のアップグレードパッケージファイルを使用する必要があります。拡張子が .hpkg のホットパッチパッケージファイルはサポートされていません。

ghe-upgrade --allow-patch-rollback EARLIER-RELEASE-UPGRADE-PACKAGE.pkg

このコマンドの実行後には再起動が必要です。パッチリリースでは移行は行われないので、ロールバックはデータパーティションには影響しません。

ghe-upgrade-scheduler

このユーティリティは、アップグレードパッケージの定期的なインストールを管理します。定期的なインストールを表示、新規作成、削除することができます。クーロン表現を使って、スケジュールを作る必要があります。詳細については、「Wikipedia の Cron のエントリ」を参照してく� さい。

ghe-upgrade-scheduler ユーティリティは、ほとんどの� �合にメンテナンスモードや再起動を必要としないホットパッチアップグレードのスケジュール設定に最適です。このユーティリティは、管理者が手動でメンテナンスモードを設定し、インスタンスを再起動して、メンテナンスモードを設定解除する必要がある、パッケージの完全アップグレードには適していません。アップグレードのさまざまな種類について詳しくは、「GitHub Enterprise Server のアップグレード」をご覧く� さい。

パッケージの新しいインストールをスケジュールするには以下のようにします。

$ ghe-upgrade-scheduler -c "0 2 15 12 *" UPGRADE-PACKAGE-FILENAME

パッケージのスケジュールされたインストールを表示するには以下のようにします。

$ ghe-upgrade-scheduler -s UPGRADE PACKAGE FILENAME
> 0 2 15 12 * /usr/local/bin/ghe-upgrade -y -s UPGRADE-PACKAGE-FILENAME > /data/user/common/UPGRADE-PACKAGE-FILENAME.log 2>&1

パッケージのスケジュールされたインストールを削除するには以下のようにします。

$ ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME

ghe-update-check

このユーティリティは、GitHub Enterprise の新規パッチのリリースがあるかどうかを確認します。リリースが存在する� �合、インスタンスに十分な容量があればパッケージをダウンロードします。デフォルトでは、 /var/lib/ghe-updates に保存されます。次に、管理者はアップグレードを実行できます。

/var/lib/ghe-updates/ghe-update-check.status にダウンロードの状態を含むファイルがあります。

-i のスイッチを使って、GitHub Enterprise の最新リリースを確認することができます。

$ ssh -p 122 admin@HOSTNAME -- 'ghe-update-check'

[ユーザー管理]

ghe-license-usage

このユーティリティは、インストールのユーザーのリストを JSON 形式でエクスポートします。インスタンスが GitHub Enterprise Cloud に接続されている� �合、GitHub Enterprise Server はこの情� �を使用してライセンス情� �を GitHub Enterprise Cloud に� �告します。詳細については、「エンタープライズアカウントを GitHub Enterprise Cloud に接続する」を参照してく� さい。

デフォルトでは、結果の JSON ファイル内のユーザのリストは暗号化されます。その他のオプションにはフラグ -h を使用します。

ghe-license-usage

ghe-org-membership-update

このユーティリティは、インスタンスでメンバー全員に対して、デフォルトの Organization メンバーシップの可視性の設定を必� �化します。詳細については、「組織メンバーシップの可視性の構成」を参照してく� さい。オプション設定は public か private です。

ghe-org-membership-update --visibility=SETTING

`ghe-user-csv`

このユーティリティは、インストール内のすべてのユーザのリストを CSV 形式でエクスポートします。 CSV ファイルにはメールアドレス、ユーザーの種類 (たとえば、管理者やユーザーなど)、所有しているリポジトリの数、SSH キーの数、組織のメンバーの数、最後にログインしたときの IP アドレスなどが含まれています。その他のオプションには -h フラグを使用します。

ghe-user-csv -o > users.csv

ghe-user-demote

このユーティリティは、指定のユーザをアドミンステータスから一般ユーザのステータスに変更します。このアクションは、Web UI を使って行うことをおすすめします。このユーティリティを提供しているのは、誤って ghe-user-promote ユーティリティを実行してしまった� �合に、CLI から再度ユーザーを降� �させるためです。

ghe-user-demote USERNAME

ghe-user-promote

このユーティリティは、指定したユーザアカウントをサイト管理人に変更します。

ghe-user-promote USERNAME

ghe-user-suspend

このユーティリティは、指定したユーザのアカウントを停止して、ログインやプッシュ、リポジトリからのプルを行えないようにします。

ghe-user-suspend USERNAME

ghe-user-unsuspend

このユーティリティは、指定したユーザの停止状態を解除して、ログインやプッシュ、リポジトリからプルを行えるようにします。

ghe-user-unsuspend USERNAME