Get Started with
SnapCommit
Everything you need to install, configure, and master SnapCommit
Complete Setup Guide
Install SnapCommit CLI
npm install -g @snapcommit/cliℹ️ Requires Node.js 16+ and npm. Works on macOS, Linux, and Windows.
Create Your Account
Visit snapcommit.dev/login and sign up with:
- Email & Password
- GitHub OAuth (recommended)
📧 After signup: Check your email and click the confirmation link. You'll be redirected to the login page. Log in to continue to your dashboard.
Subscribe to SnapCommit
Choose your plan:
$9.99/month
Cancel anytime
$100/year
Best value
💳 After payment: You'll be redirected back to your dashboard. Your subscription will be activated instantly, and you can generate your CLI token immediately!
Generate Authentication Token
Once subscribed, you'll see the "Generate Token" button in your dashboard.
Click "Generate Token"
Copy the generated token (starts with snp_)
Keep it secure! This token authenticates all your CLI requests
⚠️ Important: You need an active subscription to generate tokens. Without a subscription, the "Generate Token" button will show a subscription required message.
Launch SnapCommit
Open your terminal in any Git repository and run:
snapOn first run, you'll be prompted to paste your authentication token. After that, you're ready to go!
You're All Set! 🎉
Just type snap in any git repository and start using natural language to control Git!
Updating SnapCommit
When Update is Available
SnapCommit automatically checks for updates. When a new version is available, you'll see:
Option 1: Update from CLI (Recommended)
snap> update✨ Just type update in the SnapCommit CLI and it will handle everything!
Option 2: Manual Update
npm install -g @snapcommit/cli@latestAfter updating, run snap again to use the latest version
Usage
Interactive Mode
Type snap to enter interactive mode:
Just Talk to It 💬
SnapCommit understands plain English. Just describe what you want to do:
"commit my work"
→ AI commit with perfect message
"undo last commit"
→ Safely reverts changes
"create a PR to main"
→ Creates pull request
"check if CI passed"
→ Shows CI status
"squash last 5 commits"
→ Interactive rebase
"switch to main and pull"
→ Checkout & sync
💡 Pro Tip: There are no "commands" to memorize. Just talk naturally, like you would to a teammate. SnapCommit understands context and can handle complex requests!
GitHub Integration (Optional)
🚀 Unlock Full GitHub Features
Connect your GitHub account to create PRs, check CI status, and manage issues—all with natural language!
Quick Setup:
- 1.Run
snap github connectin your terminal - 2.Go to https://github.com/settings/tokens
- 3.Create a Personal Access Token (Classic)
- 4.Select scopes:
repo,workflow,read:user - 5.Copy the token and paste it when SnapCommit prompts you
💡 Pro Tip: Set the token expiration to "No expiration" or remember to renew it before it expires!
Troubleshooting
Can't generate token
Make sure you have an active subscription. Go to /pricing and subscribe first. After payment, you'll be able to generate tokens from your dashboard.
"Subscription required" error
Your subscription has expired. Visit snapcommit.dev/pricing to renew. Service resumes immediately after payment.
Token expired error
CLI tokens are valid for 1 year. Go to your dashboard, generate a new token, and run 'snap' again to re-authenticate.
AI commands not working
Check your internet connection. All AI features require an active connection to our servers. If issues persist, try running 'snap' again or contact support.
Update notification not showing
SnapCommit checks for updates hourly. If you want to force check, exit and run 'snap' again. Or manually run: npm install -g @snapcommit/cli@latest
CLI not found after install
Try closing and reopening your terminal. If still not working, check if npm global bin is in your PATH. Run: npm config get prefix
Frequently Asked Questions
Do I need to keep running 'snap' every time?
No! Once you run 'snap', you enter an interactive session that stays open. You can run as many commands as you want. Only exit when you're done (type 'exit' or press Ctrl+C).
What happens when my subscription expires?
All AI features will stop working immediately. You'll see a clear error message with a link to renew. Your local data (commit history, stats, tokens) stays intact, but you can't use AI features until you resubscribe.
Can I use SnapCommit in multiple terminals?
Yes! Your authentication token works across all terminals on your machine. Just run 'snap' wherever you want to use it.
Is my code secure?
Absolutely! AI only sees git diffs (changes), never your full code. GitHub tokens are stored locally on your machine. Your secrets, API keys, and sensitive data stay private.
Do I need to provide my own AI API keys?
No! SnapCommit includes built-in AI models. No setup, no configuration—just install and go.
Can I cancel my subscription anytime?
Yes! Cancel anytime from your dashboard. No questions asked. Service stops at the end of your billing period.
What if SnapCommit makes a mistake?
SnapCommit ALWAYS shows what it will do and asks for confirmation before risky operations (force push, hard reset, etc.). You're always in control.
How do I update to the latest version?
When a new version is available, SnapCommit will notify you. Just type 'update' in the CLI, or manually run: npm install -g @snapcommit/cli@latest
Account Management
View Your Subscription
Visit your dashboard to see subscription status, plan details, and expiration date.
Manage Tokens
Generate new tokens or revoke old ones from your dashboard. Each token is valid for 1 year.
Cancel Subscription
Contact support at karjunvarma2001@gmail.com to cancel. Service stops immediately but your data remains safe.
Delete Account
Contact support to request account deletion. All your data will be permanently removed.
Tips & Tricks
Use Natural Language
Just describe what you want: "commit my work", "create a PR", "fix that merge conflict". No commands to memorize!
SnapCommit Remembers Context
It learns from your actions. Say "undo that" and it knows what to undo. Say "merge my PR" without a number—it finds it automatically.
Multi-Repo Workflow
Switch between projects with "cd /path/to/project". SnapCommit adapts to each repo automatically.
Safety First
SnapCommit always confirms before dangerous operations (force push, hard reset). You're always in control.
View Your Stats
Type "stats" to see commit streaks, lines written, and productivity metrics. Great for motivation!
Exit Anytime
Type "exit" or "quit" to leave the interactive session. Or press Ctrl+C.