Documentation
Gobin Documentation
Everything you need to get started with Gobin, the AI-powered coding agent for Python developers.
Quick Start
Get Started in 3 Steps
Install Gobin
Install Gobin globally using pipx for the best experience.
pipx install gobin-cli
Setup API Key
Configure your Gemini API key as an environment variable or in a .env file.
export GEMINI_API_KEY="your_api_key_here"
Start Coding
Navigate to your Python project and start the interactive CLI.
gobin
Capabilities
What Gobin Can Do
Project Exploration
- List files and directories in the current working directory
- Inspect file contents quickly
- Navigate project structure intelligently
Code Execution
- Run Python scripts with optional CLI arguments
- Execute shell commands safely with user approval
- Interactive debugging and testing
File Management
- Create new directories
- Write or overwrite files safely
- Create parent directories automatically if necessary
Interactive AI Assistance
- Generate code snippets or function implementations
- Provide guidance and explanations for Python code
- Maintain session memory to understand ongoing tasks
Installation
Installation & Setup
Install Gobin
Gobin is published on PyPI and can be installed globally using pipx:
pipx install gobin-cli
API Key Setup
Gobin requires a Gemini API key. You can provide it either via an environment variable or a .env file:
Option A: Environment Variable
export GEMINI_API_KEY="your_api_key_here"
Option B: .env File
Create a file named .env in your project directory with:
GEMINI_API_KEY=your_api_key_here
Running the CLI
After installation and API key setup, launch the interactive AI agent:
gobin
CLI Usage Tips:
- • Exit the CLI: Type "exit" or "quit"
- • Clear the screen: Type "clear" or "cls"
- • Multiline input: Shift+Enter for a new line, Enter to submit
Example
Example Workflow
1. Navigate to your Python project directory:
cd my-python-project
2. Run Gobin:
gobin
3. Ask Gobin to create a new Python file:
> create a Python file named `utils.py` with a function to calculate factorial
4. Inspect, run, or modify your code interactively.
Continue the conversation with Gobin to refine, test, and improve your code.
Requirements
System Requirements
- Python >= 3.8
- PIPX (recommended for installation)
- Compatible with Linux, macOS, and Windows
- Terminal or shell for CLI usage
- Gemini API key
Ready to Get Started?
Install Gobin today and start building Python projects with AI assistance.