Quick Start Guide

Last updated: Nov 12, 2025 ⏱️ 5 min read

Get your first application deployed to the .git edge network in under 5 minutes. This guide walks you through installation, project setup, configuration, and your first deployment.

Prerequisites

Before you begin, ensure you have the following installed and configured:

Node.js 18+ or npm 9+
Git 2.30+ installed globally
A free .git account (sign up via GitHub, GitLab, or email)
Basic familiarity with terminal commands

💡 Pro Tip

Our CLI auto-detects your OS and architecture. No manual binary downloads required.

Install the .git CLI

Install the official command-line interface globally via npm. This gives you access to project scaffolding, configuration, and deployment commands.

Terminal

npm install -g @dotgit/cli

Verify the installation:

Terminal

git --version\n.git CLI v2.4.1

Initialize Your Project

Create a new project directory and scaffold a starter configuration. The CLI will prompt you for framework preferences and repository settings.

Terminal

                                git init-project my-app--template nextjs\n✓ Project scaffolded at ./my-app\n✓ .gitconfig.yaml created\n✓ Ready to configure
                            

ℹ️ Note

Supported templates: nextjs, remix, vite, astro, blank. Use --help for full options.

Configure Environment

Set up your deployment environment variables and branch rules. You can use the interactive wizard or edit .gitconfig.yaml directly.

.gitconfig.yaml

                                project: my-app\n  framework: nextjs\n  build_command: npm run build\n  output_dir: .next\nenvironments:\n  preview:\n    branch: "*"\n    auto_deploy: true\n  production:\n    branch: "main"\n    auto_deploy: false\n    require_approval: true
                            

Deploy a Preview Environment

Push your code and trigger an instant preview deployment. Each branch gets a unique, shareable URL with automated SSL and caching.

Terminal

                                git deploy --preview\n✓ Building...\n✓ Optimizing assets...\n✓ Deployed to edge\n  → https://my-app-branch-8f2a.git.dev
                            

Push to Production

When ready, promote your preview to production. The CLI will run your configured CI checks and apply zero-downtime rollout.

Terminal

                                git deploy --prod\n✓ Running pre-deploy checks...\n✓ Passing tests (142/142)\n✓ Deployed to production\n  → https://my-app.git.dev
                            

Verification

Visit your production URL in a browser. You should see your application running on the .git edge network with:

Automatic HTTPS (Let's Encrypt)
Global CDN caching
Real-time analytics dashboard
Instant rollback capability

Terminal

                        git status\n✓ Production: Live\n✓ Preview: 2 active\n✓ Uptime: 99.99%\n# Next command: git analytics
                    

Troubleshooting

Common Issues

Build fails with exit code 1: Check your build_command in .gitconfig.yaml. Ensure all dependencies are listed in package.json.

Preview URL returns 502: Edge cold-start can take ~1.2s. Retry after 3 seconds or run git warm to pre-activate regions.

Authentication required: Run git auth to re-sync your GitHub/GitLab tokens.

💡 Need Help?

Run git doctor to diagnose environment issues automatically, or visit our Community Discord.

Next Steps

Now that your app is live, explore these advanced features: