Skip to main content
We welcome contributions! See the full CONTRIBUTING.md on GitHub for detailed guidelines.

​
Quick Start

git clone https://github.com/onetest-ai/Octo.git
cd Octo
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[cli]"
octo init

​
Key Guidelines

  • Verify syntax after editing any Python file: .venv/bin/python -m py_compile octo/<file>.py
  • Follow existing patterns — the codebase is consistent
  • Lazy-import heavy dependencies inside factory functions
  • One change per PR — keep PRs small and focused

​
Common Changes

Since v0.5.0, the package is split into two layers: octo/core/ (embeddable engine) and octo/ root (CLI-specific code). Root-level files like graph.py and middleware.py are backward-compat re-export shims.
Change TypeFiles to Update
New LLM providerconfig.py, models.py, wizard/onboarding.py, wizard/validators.py, wizard/doctor.py, README.md
New slash commandcli.py, ui.py
New built-in toolcore/tools/, core/graph.py
New middlewarecore/middleware.py
New storage backendcore/storage/

​
Reporting Issues

  • Check existing issues first
  • Include: Python version, OS, error traceback, steps to reproduce
  • For model/provider issues: include the model name and provider

​
License

By contributing, your contributions are licensed under MIT.