Vercel CLIでよく使うコマンド一覧｜解説・使用例をまとめてみた

2025年3月時点の公式ドキュメントによると、Vercel CLIは、ターミナルからVercelプラットフォームとやり取りし、プロジェクトを管理するための強力なツールです VercelVercel。

インストールと基本設定

インストール

bash

# グローバルインストール
npm i -g vercel
# または
pnpm i -g vercel

最新版へのアップデート

npm i -g vercel@latest

バージョン確認

vercel --version

主要コマンド

1. vercel / vercel deploy

プロジェクトをVercelにデプロイするメインコマンドです。プロジェクトのルートディレクトリから実行するか、パスを指定して使用できます Vercel。

基本的な使用例:

# 現在のディレクトリをデプロイ
vercel

# プレビューデプロイ(デフォルト)
vercel

# 本番環境へデプロイ
vercel --prod

# 特定のパスからデプロイ
vercel --cwd /path-to-project

# ビルド済みプロジェクトをデプロイ
vercel --prebuilt

主なオプション:

  • --prod: 本番環境へデプロイ
  • --build-env KEY=value (-b): ビルド時の環境変数を指定
  • --env KEY=value (-e): ランタイム環境変数を指定
  • --yes: セットアップの質問をスキップ
  • --force (-f): ビルドキャッシュを使わずに強制デプロイ
  • --no-wait: デプロイ完了を待たずに終了
  • --archive=tgz: デプロイコードを圧縮してアップロード
  • --logs (-l): ビルドログも表示
  • --target=staging: デプロイ先の環境を指定(production/preview/custom)

2. vercel dev

Vercelのデプロイ環境をローカルで再現し、Functions や Middlewareをテストできるコマンドです 。

使用例:

# 開発サーバーを起動
vercel dev

# ポート番号を指定
vercel dev --listen 5005

# 質問をスキップして起動
vercel dev --yes

3. vercel build

プロジェクトをローカルまたはCI環境でビルドし、.vercel/outputフォルダを生成します Vercel。

使用例:

# プロジェクトをビルド
vercel build

# ビルド後、アーカイブしてデプロイ
vercel build
vercel deploy --prebuilt --archive=tgz

4. vercel env

プロジェクトの環境変数を管理するコマンドで、リスト表示、追加、削除、エクスポートの機能を提供します。

使用例:

# 全環境変数をリスト表示
vercel env ls

# 特定の環境の環境変数を表示
vercel env ls production
vercel env ls preview

# 環境変数を追加
vercel env add API_KEY production

# ファイルから環境変数を追加
vercel env add SECRET_KEY production < secret.txt

# 環境変数を削除
vercel env rm API_KEY production

# 開発環境の環境変数を.envファイルにプル
vercel env pull

# プレビュー環境の環境変数をプル
vercel env pull --environment=preview

# 特定のブランチの環境変数をプル
vercel env pull --environment=preview --git-branch=feature-branch

# 確認をスキップして削除
vercel env rm API_KEY --yes

5. vercel login / vercel logout

# Vercelアカウントにログイン
vercel login

# ログアウト
vercel logout

6. vercel link

ローカルディレクトリをVercelプロジェクトにリンクします。

# プロジェクトにリンク(対話式)
vercel link

# 既存プロジェクトに自動リンク
vercel link --yes

7. vercel list

デプロイメントの一覧を表示します。

# デプロイメント一覧を表示
vercel list

# メタデータでフィルタリング
vercel list --meta KEY=value

8. vercel logs

デプロイメントのログを取得します。

# 特定のデプロイメントのログを表示
vercel logs <deployment-url>

9. vercel pull

プロジェクトの設定と環境変数をローカルにプルします。

# プロジェクト設定をプル
vercel pull

# 特定の環境の設定をプル
vercel pull --environment=preview

10. vercel init

サンプルプロジェクトを作成します。

# サンプルプロジェクトを選択して作成
vercel init

11. vercel inspect

デプロイメントの詳細情報を表示します。

vercel inspect <deployment-url>

12. vercel alias

デプロイメントにカスタムドメインを割り当てます。

# エイリアスを設定
vercel alias <deployment-url> my-domain.com

13. vercel domains

ドメインを管理します。

# ドメイン一覧を表示
vercel domains ls

# ドメインを追加
vercel domains add my-domain.com

14. vercel dns

DNSレコードを管理します。

# DNSレコードを表示
vercel dns ls

15. vercel certs

SSL証明書を管理します。

# 証明書一覧を表示
vercel certs ls

16. vercel remove

デプロイメントを削除します。

vercel remove <deployment-url>

17. vercel promote

プレビューデプロイメントを本番環境に昇格させます。

vercel promote <deployment-url>

18. vercel rollback

以前のデプロイメントにロールバックします。

vercel rollback

19. vercel project

プロジェクト設定を管理します。

# プロジェクト情報を表示
vercel project ls

20. vercel redeploy

既存のデプロイメントを再デプロイします。

vercel redeploy <deployment-url>

グローバルオプション

複数のCLIコマンドで共通して使用できるグローバルオプションがあります。

  • --cwd <path>: 作業ディレクトリを指定
  • --debug (-d): 詳細な出力を表示
  • --global-config <path> (-Q): グローバル設定ディレクトリのパスを指定
  • --help (-h): ヘルプ情報を表示
  • --scope <name> (-S): 実行するスコープを指定
  • --token <token> (-t): 認証トークンを使用
  • --no-color: 色やemojiの出力を無効化

CI/CD環境での使用

CI/CD環境では、手動入力ができないため、トークンページでトークンを作成し、–tokenオプションを使用して認証します。

# トークンを使用してデプロイ
vercel --prod --token YOUR_TOKEN

# スコープも指定
vercel --prod --token YOUR_TOKEN --scope my-team

このように、Vercel CLIは豊富なコマンドを提供しており、デプロイメントの管理から環境変数の設定、ドメイン管理まで、ターミナルから包括的に操作できます。

コメント

タイトルとURLをコピーしました