Netlify

🚀 Guide to Using Netlify CLI v19.1.5

This guide provides a comprehensive overview of using Netlify CLI v19.1.5, including command examples, precautions, and advanced usage scenarios.

🚀 Quick Start

Command Example

netlify build --configuration=production

Precautions

• Authentication Method: You need to use a Personal Access Token for authentication. Interactive login commands such as netlify login, netlify init, and netlify dev are not supported.
• Context Environment: Many commands (e.g., those related to environment variables and logs) require the NETLIFY_SITE_ID environment variable to be set to specify the site ID for the current operation.

✨ Features

Supported Commands

Build and Deployment

# Build with specified configuration
netlify build --configuration=production

# Deploy to production environment
netlify deploy --configuration=production

# Generate and deploy a static website from a specified file
netlify build -c static-website.json && netlify deploy -c static-website.json

Site Management

# List all sites
netlify sites:list --json

# Get information about a specific site
netlify sites:get <site-id> --json

# Delete a specified site
netlify sites:delete <site-id>

Build Configuration File Operations

# Create a new build configuration file
netlify config:init --file netlify.config.json

# Verify an existing configuration file
netlify config:verify

Common Command Options

• Specify Configuration File: --configuration <name> or -c <name>
• Silent Mode: --silent
• Verbose Output: --verbose

Resource Links

• Netlify CLI Documentation
• Netlify Official Website

📦 Installation

Prerequisites

Ensure you have installed the following tools:

• Node.js (recommended version 14 or higher)
• npm (recommended version 6 or higher)

Install Netlify CLI

Run the following command to install:

npm install -g netlify-cli

💻 Usage Examples

Configure the Site

Create a Configuration File

Create a netlify.config.json file in the project root directory with the following content:

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

Common Commands

Build the Project

netlify build

Deploy to Production Environment

netlify deploy

Check Deployment Status

netlify status

Manage the Site

List All Sites

netlify sites:list

Get Information about a Specific Site

netlify sites:get <site-id>

Delete a Specified Site

netlify sites:delete <site-id>

Manage Environment Variables

Add an Environment Variable

netlify env:set <env-var-name> <value> --site <site-id>

View Environment Variables

netlify env:list --site <site-id>

Manage Functions

Deploy a Function

netlify functions:create --name my-function --handler src/handler.js --description "My custom function"

Trigger a Function

curl https://api.netlify.com/v1/functions/my-function?token=<function-token>

Advanced Features

Use Different Configuration Files

netlify build --configuration dev

Verify a Configuration File

netlify config:verify

📚 Documentation

Netlify CLI Command Reference

Site Management Commands

• netlify sites:list: List all associated sites.
• netlify sites:get <site-id>: Get detailed information about a specified site.
• netlify sites:create: Create a new site (API key required).
• netlify sites:update <site-id>: Update information about a specified site.
• netlify sites:delete <site-id>: Delete a specified site.

Build Commands

• netlify build: Build the project using the default configuration file.
• netlify build --configuration <name>: Build using a specified configuration file.

Deployment Commands

• netlify deploy: Deploy the content in the recently built output directory.
• netlify deploy --configuration <name>: Deploy using a specified configuration file.

Environment Variable Management Commands

• netlify env:set <var> <value> [options]: Set an environment variable.
• netlify env:list [options]: List all environment variables.
• netlify env:get <var> [options]: Get the value of a specified environment variable.

Function Management Commands

• netlify functions:create: Create a new function.
• netlify functions:list: List all deployed functions.
• netlify functions:update <function-id>: Update a specified function.
• netlify functions:delete <function-id>: Delete a specified function.

Netlify CLI Error Handling Guide

Common Errors and Solutions

Authentication Failure

Error Message:

Failed to authenticate with Netlify

Solution:

• Ensure you are logged in to your Netlify account.
• Use the correct API key or Personal Access Token.

Command Example:

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

Site Not Found

Error Message:

Site not found for that ID or name

Solution:

• Confirm that the site ID you entered is correct.
• Check for network connection issues.

Build Failure

Error Message:

Build failed due to ...

Solution:

• View the detailed build log to find the specific cause.
• Ensure that the project dependencies are correctly installed.

Advanced Topic: Optimizing Netlify Deployment Process

Integrate Netlify with CI/CD Pipeline

Example GitLab CI Configuration

stages:
  - build
  - deploy

build:
  stage: build
  script:
    - npm run build

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

Automate Deployment with 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

📄 Resources and References

Official Documentation

• Netlify CLI Documentation
• Netlify Developer Guide
• Netlify API Documentation

Community Resources

• Netlify Forum
• Netlify Blog
• Recommended Developer Blogs