Orchai is an agentic AI framework that creates orchestrator agents and their sub-agents to complete both simple and complex tasks. It is designed to facilitate the development of modular, scalable, and intelligent agent-based systems.
- Python
- uv: Fast Python package installer and resolver
- ruff: Extremely fast Python linter and formatter
- just: Command runner for project automation
- pytest: Testing framework
- crewai: Agent orchestration library
- pydantic: Data validation and settings management
- pydantic AI: AI integration for Pydantic
- dotenv: Environment variable management
- venice.ai API: Used for AI inference and agent intelligence
-
Clone the repository:
git clone <repo-url> cd orchai
-
Install dependencies:
uv pip install -r requirements.txt
-
Set up environment variables:
- Copy
.env.example
to.env
and fill in required values (e.g., Venice.ai API key).
- Copy
-
Run tests:
pytest
orchestrator/
- Main orchestrator agent logicagents/
- Sub-agent implementationstests/
- Test suite
- Use
just
to run common project commands (seejustfile
for available tasks). - Lint and format code with
ruff
. - Run and develop agents using the provided framework and Venice.ai API integration.
-
Running the Orchestrator:
just run-orchestrator
-
Developing a New Sub-Agent:
- Create a new file in the
agents/
directory. - Implement the sub-agent class by inheriting from the base agent class.
- Register the new sub-agent with the orchestrator.
- Create a new file in the
-
Using the Venice.ai API:
- Ensure your API key is set in the
.env
file. - Use the provided API client to interact with Venice.ai services.
- Ensure your API key is set in the
We welcome contributions to the Orchai project! Please follow these guidelines to contribute:
-
Fork the repository:
- Click the "Fork" button on the top right of the repository page.
-
Create a new branch:
git checkout -b feature/your-feature-name
-
Make your changes:
- Ensure your code follows the project's coding standards.
- Write tests for your changes.
-
Commit your changes:
git commit -m "Add your commit message here"
-
Push to your branch:
git push origin feature/your-feature-name
-
Create a pull request:
- Go to the repository page and click "New pull request".
If you need help or have any questions, please feel free to reach out:
- Issue Tracker: Report issues or request features on the GitHub Issues page.
- Email: Contact us at support@orchai.com.
- Community Forum: Join the discussion on our community forum.
MIT