Home › Documentation › Deploy Your First Project

Deploy Your First Project

Follow this step-by-step guide to connect your repository, configure your build settings, and ship your application to .git's global edge network in under 5 minutes.

On This Page

Prerequisites

Before you begin, ensure you have the following ready:

  • A modern Node.js runtime (v18+) or Python 3.10+
  • Git installed and configured on your machine
  • A public or private repository on GitHub, GitLab, or Bitbucket
  • A free .git account (sign up at dashboard.git.dev)
ℹ️

Framework Support

.git auto-detects Next.js, Nuxt, SvelteKit, Astro, Remix, Vite, and more. Zero config is required for most setups.

Install the .git CLI

The @git/cli package provides the official command-line interface for authenticating, configuring, and deploying projects.

npm install -g @git/cli
git auth

Running git auth will open your browser to the OAuth consent screen. Once authorized, your credentials are stored securely in ~/.git/config.

Initialize & Configure

Navigate to your project root and run the interactive initializer:

cd your-project
git init --project

The CLI will scan your codebase and generate a .gitrc file. You can edit it manually if needed:

# .gitrc
[build]
  command = "npm run build"
  output = "dist"
  node_version = "20"

[deploy]
  env = { API_URL = "https://api.yourapp.com" }
  preview_branches = ["develop", "feature/**"]
💡

Environment Variables

For security, never commit secrets. Use git env set KEY=value or configure them in the dashboard under Settings → Environment.

Deploy to Production

Once your configuration is ready, trigger your first deployment:

git deploy --prod

The CLI will bundle your assets, run your build step, and push the optimized output to .git's edge network. You'll receive a deployment URL instantly.

✓ Building project...
✓ Optimizing assets...
✓ Uploading to edge nodes...
✓ Deployed to production in 3.2s
👉 https://your-project.git.dev
⚠️

Production Guardrails

By default, direct production deploys require approval if your team has Enforced PR Merges enabled. Use git deploy --preview for non-branch deployments.

Verify & Monitor

After deployment, use the following commands to inspect your live environment:

# View deployment logs
git logs --prod

# Check real-time health metrics
git status

# Rollback to previous version (if needed)
git rollback --version v2.1.0

All deployments include automatic HTTPS, CDN caching, and error tracking. Navigate to your dashboard to set up uptime monitors, custom domains, and team access controls.

Ready to scale?

Connect a custom domain, enable CI/CD pipelines, or invite your team to collaborate.

Open Dashboard →