Netlify

🚀 Netlify CLI v19.1.5の使用説明

Netlify CLI v19.1.5を使用すると、Netlify上でのサイトの構築、デプロイ、管理が容易に行えます。このドキュメントでは、CLIの使い方やサポートされるコマンド、注意事項などを詳しく説明します。

🚀 クイックスタート

コマンド例

netlify build --configuration=production

注意事項

⚠️ 重要提示

• 認証方式：個人アクセストークン（Personal Access Token）を使用して認証する必要があり、netlify login、netlify init、netlify dev などの対話型ログインコマンドはサポートされていません。
• コンテキスト環境：多くのコマンド（環境変数やログに関連するコマンドなど）では、NETLIFY_SITE_ID 環境変数を設定して現在操作するサイトのIDを指定する必要があります。

✨ 主な機能

サポートされるコマンド

構築とデプロイ

# 指定された構成を使用してビルド
netlify build --configuration=production

# 本番環境にデプロイ
netlify deploy --configuration=production

# 指定されたファイルから静的サイトを生成してデプロイ
netlify build -c static-website.json && netlify deploy -c static-website.json

サイト管理

# すべてのサイトをリストする
netlify sites:list --json

# 特定のサイト情報を取得する
netlify sites:get <site-id> --json

# 指定されたサイトを削除する
netlify sites:delete <site-id>

構築構成ファイル操作

# 新しい構築構成ファイルを作成する
netlify config:init --file netlify.config.json

# 既存の構成ファイルを検証する
netlify config:verify

一般的なコマンドオプション

• 構成ファイルの指定：--configuration <name> または -c <name>
• サイレントモード：--silent
• 詳細出力：--verbose

📦 インストール

準備

• Node.js（推奨バージョン 14 以上）
• npm（推奨バージョン 6 以上）

Netlify CLIのインストール

npm install -g netlify-cli

💻 使用例

基本的な使用法

サイトの構築とデプロイ

# デフォルトの構成ファイルを使用してビルド
netlify build

# 最近のビルド出力ディレクトリの内容をデプロイ
netlify deploy

高度な使用法

異なる構成ファイルの使用

netlify build --configuration dev

構成ファイルの検証

netlify config:verify

📚 ドキュメント

Netlify CLIコマンドリファレンス

サイト管理コマンド

• netlify sites:list：関連付けられたすべてのサイトをリストします。
• netlify sites:get <site-id>：指定されたサイトの詳細情報を取得します。
• netlify sites:create：新しいサイトを作成します（APIキーが必要です）。
• netlify sites:update <site-id>：指定されたサイトの情報を更新します。
• netlify sites:delete <site-id>：指定されたサイトを削除します。

構築コマンド

• netlify build：デフォルトの構成ファイルを使用してプロジェクトをビルドします。
• netlify build --configuration <name>：指定された構成ファイルを使用してビルドします。

デプロイコマンド

• netlify deploy：最近のビルド出力ディレクトリの内容をデプロイします。
• netlify deploy --configuration <name>：指定された構成ファイルを使用してデプロイします。

環境変数管理コマンド

• netlify env:set <var> <value> [options]：環境変数を設定します。
• netlify env:list [options]：すべての環境変数をリストします。
• netlify env:get <var> [options]：指定された環境変数の値を取得します。

関数管理コマンド

• netlify functions:create：新しい関数を作成します。
• netlify functions:list：すべてのデプロイされた関数をリストします。
• netlify functions:update <function-id>：指定された関数を更新します。
• netlify functions:delete <function-id>：指定された関数を削除します。

Netlify CLIエラー処理ガイド

一般的なエラーと解決策

1. 認証失敗

エラーメッセージ：

Failed to authenticate with Netlify

解決策：

• Netlifyアカウントにログインしていることを確認してください。
• 正しいAPIキーまたは個人アクセストークン（Personal Access Token）を使用してください。 コマンド例：

netlify login --token your-personal-access-token

2. サイトが見つからない

エラーメッセージ：

Site not found for that ID or name

解決策：

• 入力したサイトIDが正しいことを確認してください。
• ネットワーク接続に問題がないことを確認してください。

3. ビルド失敗

エラーメッセージ：

Build failed due to ...

解決策：

• 詳細なビルドログを確認して、具体的な原因を特定してください。
• プロジェクトの依存関係が正しくインストールされていることを確認してください。

🔧 技術詳細

CI/CDパイプラインを使用したNetlifyの統合

GitLab CIの例

stages:
  - build
  - deploy

build:
  stage: build
  script:
    - npm run build

deploy:
  stage: deploy
  script:
    - netlify deploy --configuration production

GitHub Actionsを使用した自動デプロイ

name: Netlify Deployment

on:
  push:
    branches: [ main ]

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      
      - name: Install dependencies and build
        run: npm install && npm run build
      
      - name: Deploy to Netlify
        uses: netlify/deploy-action@v3

📄 ライセンス

原READMEにライセンス情報が記載されていないため、このセクションは省略されています。

🔗 リソースリンク

• Netlify CLI ドキュメント
• Netlify 公式サイト
• Netlify 開発者ガイド
• Netlify API ドキュメント
• Netlify フォーラム
• Netlify ブログ
• 開発者ブログ推薦