thegent

English

简体中文
繁體中文
فارسی
Pinglish

English

简体中文
繁體中文
فارسی
Pinglish

Appearance

Tutorial 1: Quick Start ​

Get thegent up and running in 5 minutes.

Prerequisites ​

  • Python 3.10+
  • Rust (for high-performance extensions)
  • Homebrew (macOS) or package manager (Linux)

Step 1: Installation ​

macOS / Linux ​

bash
curl -fsSL https://raw.githubusercontent.com/kooshapari/thegent/main/scripts/bootstrap.sh | sh -s -- install

From Source ​

bash
git clone https://github.com/kooshapari/thegent
cd thegent
pip install -e .

Step 2: Setup ​

Run the interactive setup wizard:

bash
thegent setup --wizard

This will guide you through:

  1. Basic configuration (MCP host, port, directories)
  2. Model defaults (Cursor, Gemini, Copilot, Claude, Codex)
  3. Performance settings (timeouts, routing)
  4. Budget settings (optional)
  5. Advanced settings (optional)

Or use defaults:

bash
thegent setup

Step 3: Verify Installation ​

Check that everything is set up correctly:

bash
thegent doctor

You should see:

  • ✓ All dependencies installed
  • ✓ Configuration valid
  • ✓ MCP server accessible
  • ✓ Shims installed

Step 4: Run Your First Agent ​

bash
thegent run "Analyze the current directory structure" free

This runs a free agent (Copilot) to analyze your directory.

Step 5: Check Status ​

bash
thegent ps

This shows active and historical agent sessions.

Next Steps ​

Troubleshooting ​

If you encounter issues:

  1. Run thegent doctor to diagnose problems
  2. Check Troubleshooting Guide
  3. Run thegent doctor --fix to attempt automatic fixes

Common Issues ​

Command Not Found ​

If thegent command is not found:

bash
# Add to PATH
export PATH="$HOME/.local/bin:$PATH"

# Add to shell profile
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

MCP Server Not Running ​

bash
# Start MCP server
thegent mcp up

# Or use task
task dev

Configuration Errors ​

bash
# Validate configuration
thegent config validate

# Run wizard again
thegent config wizard

Success! ​

You're now ready to use thegent! Continue to the next tutorial to learn about configuration.