Skip to content

📦 Installation

This package is intended to be consumed by downstream client applications as a shared dependency. Because it relies heavily on the internal orchestration framework, mirai-agent-core must also be installed.


In your downstream client application, use uv to install both the core framework and the shared skills package securely via SSH.

# Install the core framework
uv add "mirai-agent-core @ git+ssh://git@github.com/mirai-srl/mirai-agent-core.git@main"

# Install the shared skills package
uv add "mirai-shared-skills @ git+ssh://git@github.com/mirai-srl/mirai-shared-skills.git@main"

Note: You must have appropriate SSH keys configured for your GitHub account to access the mirai-srl organization repositories.


📂 Project Structure Benefits

By adopting the shared package approach, your client application directory structure becomes significantly cleaner. You no longer need a dedicated folder for common domains; they are managed entirely via your package manager.

my-client-project/
├── pyproject.toml         # Manages your uv dependencies
└── src/
    ├── main.py            # Instantiates the orchestrator and AG-UI stream
    └── agents/            # Defines client-specific Worker engines using imported skills
```