Quickstart Guide

Get your first project live in under 3 minutes. This guide walks you through installation, configuration, and your first deployment.

ℹ️

Prerequisites

Before getting started, ensure you have Node.js 18+ or Python 3.10+ installed, along with a Git repository ready to deploy.

1. Install the .git CLI

The .git CLI is the recommended way to interact with the platform. Install it globally using your preferred package manager:

bash

# Using npm
npm install -g @git/cli

# Using Homebrew (macOS)
brew install git-tap/git/cli

# Using pip
pip install git-cli

Verify the installation by running:

bash

git --version

2. Authenticate

Link your account to the CLI. This generates a secure OAuth token scoped to your workspace.

bash

git auth login

This will open your default browser to complete the OAuth flow. Once authenticated, your token is stored securely in ~/.git/config.

⚠️

Security Note

Never commit your .git/credentials file to version control. Use environment variables or secret managers for sensitive data.

3. Deploy Your First Project

Navigate to your project directory and initialize a new deployment configuration:

bash

cd ./my-awesome-app
git deploy init

The CLI will prompt you to select your runtime, build command, and output directory. Alternatively, you can create a .git.json configuration file manually:

json

{
  "build": {
    "command": "npm run build",
    "outputDirectory": "dist",
    "environment": "nodejs20"
  },
  "deploy": {
    "region": "auto",
    "ssl": true,
    "cache": true
  }
}

Environment Variables

Manage secrets and configuration using the CLI or dashboard. Variables are injected at build time and runtime automatically.

Variable	Type	Description
`GIT_API_KEY`	Secret	Required for programmatic deployments
`NODE_ENV`	String	Defaults to `production` for live builds
`PORT`	Number	Automatically assigned by the platform

💡

Pro Tip

Use git deploy --preview to generate instant preview URLs for pull requests. They auto-update as commits are pushed.

4. Verify & Monitor

After deployment, you can stream logs in real-time or access the dashboard:

bash

git deploy logs --follow
git dashboard open

That's it! Your application is now live on the global edge network with automatic HTTPS, caching, and zero-downtime rollbacks.

Next steps: Configure CI/CD pipelines · Set up custom domains · API authentication guide