Netlify

🚀 使用 Netlify CLI v19.1.5 的說明

本指南將詳細介紹如何使用 Netlify CLI v19.1.5，包括命令示例、注意事項、安裝配置、命令參考、錯誤處理以及進階主題等內容，幫助你高效地進行站點構建、部署和管理。

🚀 快速開始

準備工作

確保你已經安裝了以下工具：

• Node.js（建議版本 14 或更高）
• npm（建議版本 6 或更高）

安裝 Netlify CLI

運行以下命令進行安裝：

npm install -g netlify-cli

✨ 主要特性

• 支持多種命令，涵蓋構建、部署、站點管理、配置文件操作等功能。
• 可通過指定配置文件進行靈活的構建和部署。
• 提供詳細的錯誤處理指南，幫助解決常見問題。
• 支持與 CI/CD 管道集成，實現自動化部署。

📦 安裝指南

安裝要求

確保你已經安裝了 Node.js（建議版本 14 或更高）和 npm（建議版本 6 或更高）。

安裝命令

npm install -g netlify-cli

💻 使用示例

基礎用法

構建和部署

# 使用指定配置構建
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

高級用法

使用不同配置文件

netlify build --configuration dev

驗證配置文件

netlify config:verify

📚 詳細文檔

常用命令選項

• 指定配置文件：--configuration <name> 或 -c <name>
• 靜默模式：--silent
• 詳細輸出：--verbose

資源鏈接

• Netlify CLI 文檔
• Netlify 官方網站

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 錯誤處理指南

常見錯誤及解決方案

認證失敗

錯誤信息：

Failed to authenticate with Netlify

解決方法：

• 確保你已登錄到 Netlify 賬戶。
• 使用正確的 API 密鑰或個人訪問令牌（Personal Access Token）。

命令示例：

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

站點未找到

錯誤信息：

Site not found for that ID or name

解決方法：

• 確認你輸入的站點 ID 是否正確。
• 檢查是否有網絡連接問題。

構建失敗

錯誤信息：

Build failed due to ...

解決方法：

• 查看詳細的構建日誌，找出具體原因。
• 確保項目的依賴項已正確安裝。

進階主題：Netlify 部署流程優化

使用 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

🔧 技術細節

注意事項

• 認證方式：需要使用個人訪問令牌（Personal Access Token）進行認證，不支持交互式登錄命令如 netlify login、netlify init 和 netlify dev。
• 上下文環境：許多命令（例如與環境變量和日誌相關的命令）要求設置 NETLIFY_SITE_ID 環境變量來指定當前操作的站點 ID。

配置文件示例

在項目根目錄下創建 netlify.config.json 文件，內容如下：

{
  "build": {
    "command": "npm run build",
    "directory": "dist"
  },
  "functions": {
    "directory": "./src/functions"
  }
}

📄 許可證

文檔中未提及相關許可證信息。

⚠️ 重要提示

• 認證需要使用個人訪問令牌（Personal Access Token），不支持交互式登錄命令。
• 許多命令要求設置 NETLIFY_SITE_ID 環境變量來指定當前操作的站點 ID。

💡 使用建議

• 在使用 Netlify CLI 前，確保你已經安裝了所需的工具（Node.js 和 npm）。
• 遇到錯誤時，參考錯誤處理指南進行排查和解決。
• 可以使用 CI/CD 管道集成 Netlify，實現自動化部署，提高效率。