Quick Start

Get your first project live in under 5 minutes. Follow this guide to install the .git CLI, initialize your repository, and deploy to our global edge network.

Prerequisites

Before getting started, ensure your environment meets the following requirements:

  • Node.js 18.0 or later
  • npm 9+, yarn 1.22+, or pnpm 8+
  • Git 2.30+
  • A free or paid .git account
💡 Tip

Verify your versions with node -v and git --version. Outdated versions may cause unexpected behavior during initialization.

1. Install the CLI

The .git command-line interface automates project setup, builds, and deployments. Install it globally using your preferred package manager:

bash 
# Using npm
npm install -g @dotgit/cli

# Using yarn
yarn global add @dotgit/cli

# Using pnpm
pnpm add -g @dotgit/cli

Verify the installation by running:

bash 
git --version
# Output: .git CLI v2.4.1

2. Initialize a Project

Navigate to your project directory and run the init command. The CLI will scaffold a minimal configuration and link your local repository.

bash 
cd /path/to/your-project
git init --template=next-app

This creates a .git/config.yaml file in your root directory. The CLI automatically detects your framework and applies optimized build settings.

3. Configure Your Pipeline

Edit .git/config.yaml to define build commands, output directories, and environment variables.

yaml 
name: my-awesome-app
build:
  command: npm run build
  output: .next

env:
  - name: DATABASE_URL
    value: <your-db-connection-string>
  - name: NODE_ENV
    value: production

deploy:
  region: auto
  preview_branches:
    - /^feature\/.*$
  production_branch: main
✅ Auto-Detection

.git automatically configures frameworks like Next.js, Remix, Astro, and Vite. Override defaults by explicitly setting build.command.

4. Deploy to Production

Commit your configuration and push to trigger your first deployment. Preview URLs are generated for every branch automatically.

bash 
git add .
git commit -m "chore: configure .git pipeline"
git push origin main

Watch the deployment progress in real-time:

bash 
git deploy --follow
▶ Syncing repository...
▶ Running build: npm run build
✔ Build succeeded (4.2s)
▶ Optimizing assets...
▶ Deploying to edge network...
✔ Live: https://my-app.git.dev

Your site is now live globally. DNS propagation, SSL provisioning, and cache warming happen automatically.

Next Steps

Now that your project is deployed, explore these resources to get the most out of .git:

  • Framework Guides: Next.js, Remix, SvelteKit, Astro, Vite
  • Environment Variables: Managing secrets & runtime config
  • Custom Domains: DNS setup & SSL management
  • CI/CD Pipelines: Advanced branching & auto-rollback
  • API Reference: Programmatically manage deployments
🚀 Ready to scale?

Configure team access roles, set up Slack alerts, and monitor performance with our built-in observability dashboard.