Skip to main content

​
System requirements

  • Python 3.9 or later
  • Git 2.20 or later
  • 512 MB RAM minimum (2 GB recommended for agents with local memory)

​
Install via pip

pip install gitagent
Verify the installation: 
gitagent --version
# gitagent 0.8.0

​
Install with extras

GitAgent has optional extras for specific use cases: 
# Local embeddings for memory (adds sentence-transformers)
pip install "gitagent[memory]"

# All extras
pip install "gitagent[all]"

​
Install from source

git clone https://github.com/LyzrCore/gitagent
cd gitagent
pip install -e ".[dev]"

​
Updating

pip install --upgrade gitagent
After major version upgrades, run: 
gitagent migrate
This updates any agent.yaml files in the current directory to the latest schema version.

​
Environment variables

VariableRequiredDescription
OPENAI_API_KEYIf using OpenAIOpenAI API key
ANTHROPIC_API_KEYIf using ClaudeAnthropic API key
GITAGENT_MODELNoDefault model to use (overrides agent.yaml)
GITAGENT_LOG_LEVELNoLog level: DEBUG, INFO, WARNING, ERROR
GITAGENT_MEMORY_PATHNoPath for local memory storage (default: ~/.gitagent/memory)
GITAGENT_PLUGINS_PATHNoExtra directory to scan for plugins

​
Model provider setup

​
OpenAI

export OPENAI_API_KEY=sk-...
In agent.yaml: 
model:
  provider: openai
  name: gpt-4o          # or gpt-4o-mini, gpt-4-turbo, etc.

​
Anthropic

export ANTHROPIC_API_KEY=sk-ant-...
In agent.yaml: 
model:
  provider: anthropic
  name: claude-3-5-sonnet-20241022

​
Azure OpenAI

export AZURE_OPENAI_API_KEY=...
export AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com
In agent.yaml: 
model:
  provider: azure-openai
  name: gpt-4o             # deployment name
  api_version: "2024-02-01"

​
Local models (Ollama)

# Start Ollama with your model
ollama serve
ollama pull llama3.2
In agent.yaml: 
model:
  provider: ollama
  name: llama3.2
  base_url: http://localhost:11434

​
CI/CD installation

​
GitHub Actions

- name: Install GitAgent
  run: pip install gitagent

- name: Run agent
  run: gitagent run "${{ github.event.inputs.prompt }}"
  env:
    OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

​
Docker

FROM python:3.11-slim
RUN pip install gitagent
WORKDIR /agent
COPY . .
CMD ["gitagent", "run"]

​
Troubleshooting

gitagent: command not found Python scripts directory is not in PATH. Add it: 
# macOS/Linux
export PATH="$PATH:$(python -m site --user-base)/bin"

# Or install in a virtual environment
python -m venv .venv && source .venv/bin/activate
pip install gitagent
agent.yaml not found Run gitagent from the directory that contains agent.yaml, or pass the path explicitly: 
gitagent run --agent-dir /path/to/my-agent "your prompt"
Model errors / authentication failures Verify your API key is set and valid: 
gitagent doctor
gitagent doctor checks: Python version, API key validity, model connectivity, and directory structure compliance.