Netlify

🚀 使用 Netlify CLI v19.1.5 的说明

本指南详细介绍了 Netlify CLI v19.1.5 的使用方法，涵盖命令示例、注意事项、支持的命令、常用选项等内容，帮助你高效使用该工具进行项目构建、部署和站点管理。

🚀 快速开始

安装要求

确保你已经安装了以下工具：

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

安装 Netlify CLI

运行以下命令进行安装：

npm install -g netlify-cli

创建配置文件

在项目根目录下创建 netlify.config.json 文件，内容如下：

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

✨ 主要特性

• 支持多种命令进行项目的构建、部署和站点管理。
• 可通过配置文件灵活定制构建和部署流程。
• 提供环境变量管理和函数管理功能。

📦 安装指南

安装依赖工具

确保系统中已安装 Node.js（建议版本 14 或更高）和 npm（建议版本 6 或更高）。

安装 Netlify CLI

使用以下命令全局安装 Netlify CLI：

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

自动化部署

使用 GitLab CI 或 GitHub Actions 进行自动化部署。

示例 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

📚 详细文档

常用命令选项

• 指定配置文件：--configuration <name> 或 -c <name>
• 静默模式：--silent
• 详细输出：--verbose

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>：删除指定函数。

🔧 技术细节

认证方式

需要使用个人访问令牌（Personal Access Token）进行认证，不支持交互式登录命令如 netlify login、netlify init 和 netlify dev。

上下文环境

许多命令（例如与环境变量和日志相关的命令）要求设置 NETLIFY_SITE_ID 环境变量来指定当前操作的站点 ID。

📄 许可证

文档中未提及相关许可证信息。

🔧 技术细节

认证与上下文

• 认证方式：需使用个人访问令牌（Personal Access Token）认证，不支持 netlify login、netlify init 和 netlify dev 等交互式登录命令。
• 上下文环境：许多命令（如环境变量和日志相关命令）要求设置 NETLIFY_SITE_ID 环境变量以指定当前操作的站点 ID。

📄 资源链接

• Netlify CLI 文档
• Netlify 开发人员指南
• Netlify API 文档
• Netlify 论坛
• Netlify 博客
• 开发者博客推荐

🔧 错误处理

常见错误及解决方案

认证失败

错误信息：

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 ...

解决方法：

• 查看详细的构建日志，找出具体原因。
• 确保项目的依赖项已正确安装。