Installation
Install Gobi CLI globally using npm:
npm i -g @gourmanddev/cli
Two Ways to Use Gobi CLI
Quick Overview: Gobi CLI works in two modes - TUI for interactive
conversations or headless for automated commands.
Interactive development sessionsStart a conversation with AI in your terminal:cn
> @src/app.js Generate unit tests for this component
Perfect for exploration, debugging, and iterative development. Automation and scriptingSingle commands that return results:cn -p "Generate a commit message for current changes"
cn -p "Review the last 5 commits for issues"
Perfect for CI/CD, git hooks, and automated workflows.
Setup
cn TUI Mode
cn Headless Mode
For interactive development and exploration:Login to Gobi CLI
This will open your browser to authenticate with Gobi Hub. Test TUI Mode
Start an interactive session:Try asking a question: For automation workflows and scripting:Get API Key for Automation
For automation workflows, get an API key:
- Visit Gobi Hub API Keys
- Click ”+ New API Key”
- Copy the API key immediately (you won’t see it again!)
- Login using your Gobi account
Add Secrets for Workflows
Store secure credentials for CLI workflows:
- Visit Gobi Hub Secrets
- Add your API keys and sensitive data
- Reference in configurations with
${{ secrets.SECRET_NAME }}
Test Headless Mode
Try headless mode for automation:cn -p "Generate a conventional commit message for the current git changes"
What’s Next?
Quick Start Guide
Learn basic usage with practical examples
Create your first workflow
Build automated workflows with Gobi CLI
Getting Help
If you encounter issues: