CodePush CLI リファレンス
注記
この例ではプラグインモードの構文を使用しています。スタンドアロンモードでは、bitrise :codepush を codepush に置き換えてください。
任意のコマンドの詳細なフラグと使用方法については、bitrise :codepush <command> --helpを実行してください。
グローバルフラグClick to copy link
| Flag | Description |
|---|---|
--app-id | Release managementアプリのUUID(環境変数: CODEPUSH_APP_ID) |
--json、-j | 結果をJSONとして標準出力に出力します |
--server-url | APIサーバーのベースURL(環境変数: CODEPUSH_SERVER_URL) |
--progress-style | プログレスインジケーターのスタイル: bar(デフォルト)、spinner、counter |
コマンドClick to copy link
Release managementClick to copy link
| Command | Description |
|---|---|
bundle | OTAアップデート用にJavaScriptをバンドルします |
push [bundle-path] | OTAアップデートをプッシュします |
rollback | 以前のリリースにロールバックします |
promote | リリースを1つのデプロイから別のデプロイへプロモートします |
patch | 既存のリリースのメタデータを更新します |
デプロイの管理Click to copy link
| Command | Description |
|---|---|
deployment list | すべてのデプロイを一覧表示します(キー列を含めるには--display-keys / -k) |
deployment add <name> | 新しいデプロイを作成します(カスタムデプロイキーには--key / -k) |
deployment info <deployment> | デプロイの詳細と最新のリリースを表示します |
deployment rename <deployment> | デプロイの名前を変更します(--name、-n) |
deployment remove <deployment> | デプロイを削除します(確認には--yes / -y) |
deployment history <deployment> | リリース履歴を表示します(--limit / -n、デフォルトは10件、作成者列を含めるには--display-author / -a) |
deployment clear <deployment> | デプロイからすべてのアップデートを削除します(確認には--yes / -y) |
アップデートの管理Click to copy link
| Command | Description |
|---|---|
update info <deployment> | アップデートの詳細を表示します(特定のバージョンには--label / -lを使用) |
update status <deployment> | アップデートの処理状況とデルタ生成のステータスを表示します(--label / -l) |
update remove <deployment> | アップデートを削除します(--label / -lが必須、確定には--yes / -y) |
セットアップClick to copy link
| Command | Description |
|---|---|
init | アプリIDを使用してプロジェクト設定(.codepush.json)を初期化します |
auth login | Bitrise APIトークンをローカルに保存します |
auth revoke | 保存されたAPIトークンを削除します |
開発 者ツールClick to copy link
| Command | Description |
|---|---|
debug <platform> | 接続されたデバイスまたはシミュレーターからCodePushのログ出力をストリーミングします(androidまたはios) |
その他Click to copy link
| Command | Description |
|---|---|
version | バージョン情報を表示します |
Environment variablesClick to copy link
| Variable | Description |
|---|---|
BITRISE_API_TOKEN | 認証用のAPIトークン |
CODEPUSH_APP_ID | デフォルトのrelease managementアプリUUID(--app-idが設定されていない場合に使用) |
CODEPUSH_DEPLOYMENT | デフォルトのdeployment nameまたはUUID(--deploymentが設定されていない場合に使用) |
CODEPUSH_SERVER_URL | APIサーバーのベースURL(--server-urlが設定されていない場合に使用) |
NO_COLOR | ターミナルのカラー出力を無効にします |
Bitrise CI変数(自動的に読み込まれます)Click to copy link
| Variable | Description |
|---|---|
BITRISE_BUILD_NUMBER | プッシュのメタデータに付加されます |
BITRISE_DEPLOY_DIR | サマリーファイルのエクスポート先ディレクトリ |
GIT_CLONE_COMMIT_HASH | プッシュのメタデータに付加されます |
エクスポートされる変数(Bitrise CI)Click to copy link
push、rollback、promote、またはpatchが成功すると、CLIは下流のBitrise stepsのためにこれらをenvman経由でエクスポートします。
| Variable | Description |
|---|---|
CODEPUSH_UPDATE_ID | 作成または変更されたアップデートのID |
CODEPUSH_APP_VERSION | リリースのアプリバージョン |
CODEPUSH_LABEL | リリースラベル(patchコマンドのみ) |
終了コードClick to copy link
| Code | Meaning |
|---|---|
0 | 成功 |
1 | エラー(認証失敗、APIエラー、検証エラーなど) |
終了コードが0以外の場合は、操作が失敗したことを意味します。エラーメッセージについては、標準エラー出力を確認してください。