Quick Start Guide

Get your first project up and running on .git in under 5 minutes. This guide walks you through installation, initial configuration, and your first deployment.

1. Install the CLI

The git CLI is your primary interface for managing projects, deployments, and configuration files locally.

# Install globally via npm
npm install -g @git/cli

# Verify installation
git --version  → 2.4.1

2. Authenticate

Connect your local environment to your .git account. You can authenticate interactively or via environment variable.

# Interactive login (opens browser)
git auth login

# Or using an API key
export GIT_API_KEY="sk_live_abc123..."
git auth verify

3. Initialize Your Project

Create a new project directory and initialize the configuration file. The CLI will auto-detect your framework and generate optimized defaults.

mkdir my-app && cd my-app
git init --template nextjs
✓ Detected framework: Next.js 14
✓ Generated: .git/config.yml
✓ Ready to deploy.

4. Deploy to Production

Push your code and trigger a build. .git handles containerization, edge routing, and SSL provisioning automatically.

git deploy --prod --alias my-app.git.dev
⠋ Building...
✓ Optimized for edge runtime
✓ Provisioned custom domain
→ https://my-app.git.dev is live.

Configuration File

The .git/config.yml file controls build commands, environment variables, and routing rules. Here's a minimal example:

build:
  command: "npm run build"
  output: ".next"
  node: "18.x"

environment:
  DATABASE_URL: "@secrets/db-url"
  NEXT_PUBLIC_API: "https://api.git.dev"

routes:
  - source: "/:path*"
    destination: "/index.html"    
    type: "rewrite"

Next Steps

You're now ready to build and ship faster. Explore the following guides to unlock advanced workflows: