Netlify Deployment Automation
Deploy web projects to Netlify using the Netlify CLI (`npx netlify`).
Content
Deploy web projects to Netlify using the Netlify CLI with intelligent detection of project configuration and deployment context.
Overview
This skill automates Netlify deployments by:
- -Verifying Netlify CLI authentication
- -Detecting project configuration and framework
- -Linking to existing sites or creating new ones
- -Deploying to production or preview environments
Prerequisites
- -Netlify CLI: Installed via npx (no global install required)
- -Authentication: Netlify account with active login session
- -Project: Valid web project in current directory
- -When sandboxing blocks the deployment network calls, rerun with
sandbox_permissions=require_escalated. - -The deployment might take a few minutes. Use appropriate timeout values.
Authentication Pattern
The skill uses the pre-authenticated Netlify CLI approach:
1. Check authentication status with npx netlify status
2. If not authenticated, guide user through npx netlify login
3. Fail gracefully if authentication cannot be established
Authentication uses either:
- -Browser-based OAuth (primary):
netlify loginopens browser for authentication - -API Key (alternative): Set
NETLIFY_AUTH_TOKENenvironment variable
Workflow
1. Verify Netlify CLI Authentication
Check if the user is logged into Netlify:
Expected output patterns:
- -✅ Authenticated: Shows logged-in user email and site link status
- -❌ Not authenticated: "Not logged into any site" or authentication error
If not authenticated, guide the user:
This opens a browser window for OAuth authentication. Wait for user to complete login, then verify with netlify status again.
Alternative: API Key authentication
If browser authentication isn't available, users can set:
Tokens can be generated at: https://app.netlify.com/user/applications#personal-access-tokens
2. Detect Site Link Status
From netlify status output, determine:
- -Linked: Site already connected to Netlify (shows site name/URL)
- -Not linked: Need to link or create site
3. Link to Existing Site or Create New
If already linked → Skip to step 4
If not linked, attempt to link by Git remote:
If link fails (site doesn't exist on Netlify):
This guides user through:
1. Choosing team/account
2. Setting site name
3. Configuring build settings
4. Creating netlify.toml if needed
4. Verify Dependencies
Before deploying, ensure project dependencies are installed:
5. Deploy to Netlify
Choose deployment type based on context:
Preview/Draft Deploy (default for existing sites):
This creates a deploy preview with a unique URL for testing.
Production Deploy (for new sites or explicit production deployments):
This deploys to the live production URL.
Deployment process:
1. CLI detects build settings (from netlify.toml or prompts user)
2. Builds the project locally
3. Uploads built assets to Netlify
4. Returns deployment URL
6. Report Results
After deployment, report to user:
- -Deploy URL: Unique URL for this deployment
- -Site URL: Production URL (if production deploy)
- -Deploy logs: Link to Netlify dashboard for logs
- -Next steps: Suggest
netlify opento view site or dashboard
Handling netlify.toml
If a netlify.toml file exists, the CLI uses it automatically. If not, the CLI will prompt for:
- -Build command: e.g.,
npm run build,next build - -Publish directory: e.g.,
dist,build,.next
Common framework defaults:
- -Next.js: build command
npm run build, publish.next - -React (Vite): build command
npm run build, publishdist - -Static HTML: no build command, publish current directory
The skill should detect framework from package.json if possible and suggest appropriate settings.
Example Full Workflow
Error Handling
Common issues and solutions:
"Not logged in"
→ Run npx netlify login
"No site linked"
→ Run npx netlify link or npx netlify init
"Build failed"
→ Check build command and publish directory in netlify.toml or CLI prompts
→ Verify dependencies are installed
→ Review build logs for specific errors
"Publish directory not found"
→ Verify build command ran successfully
→ Check publish directory path is correct
Troubleshooting
Escalated Network Access
If deployment fails due to network issues (timeouts, DNS errors, connection resets), rerun the deploy with escalated permissions (use sandbox_permissions=require_escalated). The deploy requires escalated network access when sandbox networking blocks outbound requests.
Example guidance to the user:
Environment Variables
For secrets and configuration:
1. Never commit secrets to Git
2. Set in Netlify dashboard: Site Settings → Environment Variables
3. Access in builds via process.env.VARIABLE_NAME
Tips
- -Use
netlify deploy(no--prod) first to test before production - -Run
netlify opento view site in Netlify dashboard - -Run
netlify logsto view function logs (if using Netlify Functions) - -Use
netlify devfor local development with Netlify Functions
Reference
- -Netlify CLI Docs: https://docs.netlify.com/cli/get-started/
- -netlify.toml Reference: https://docs.netlify.com/configure-builds/file-based-configuration/
Bundled References (Load As Needed)
FAQ
Discussion
Loading comments...