Quick Start Guide

Get your first project live in under 5 minutes.

⏱ ~5 min read 📦 v2.4.0 ✅ Updated: Dec 2025

Prerequisites

Before you begin, ensure you have the following:

💡

New to .git? Our CLI handles environment setup, dependency resolution, and deployment configuration automatically.

Install the official @dotgit/cli package globally using your preferred package manager.

Bash / Zsh

npm install -g @dotgit/cli
# or
yarn global add @dotgit/cli
# or
pnpm add -g @dotgit/cli

Verify the installation by running git --version. You should see output similar to .git CLI v2.4.0.

Navigate to your project directory and run the interactive setup wizard. It will detect your framework and auto-generate configuration files.

Bash / Zsh

cd your-project-directory
git init

✨

The wizard will create a .gitconfig file and link your repository to your workspace automatically.

Set your environment variables securely. The CLI supports .env files, Vault integration, and inline configuration.

.env.example

PORT=3000
DATABASE_URL=postgresql://user:pass@localhost/dbname
NODE_ENV=production
API_KEY=${YOUR_API_KEY}

Apply your configuration to your workspace:

Bash / Zsh

git env sync --workspace production

Push your changes and trigger an automated deployment. The CLI will build, test, and deploy to your selected environment.

Bash / Zsh

git push origin main
git deploy --prod --wait

⚠️

Use --preview to generate a temporary URL for pull requests before merging to main.

Once complete, your app will be live at your custom domain or *.git.dev subdomain. Open the terminal output link to verify.

Now that your project is live, explore advanced features to optimize your workflow.