Installation¶
This guide covers how to install janito.
From PyPI¶
The easiest way to install janito is from PyPI:
Or, with uv (recommended):
From Source¶
For development or the latest features, install from source:
Prerequisites¶
- Python 3.10+
- Git
- uv (project & package manager)
- GitHub CLI (optional)
Clone and Install¶
# Clone the repository
git clone https://github.com/ikignosis/janito.git
cd janito
# Create the virtual environment and install the project + dev dependencies
uv sync
uv sync installs janito in editable mode by default and installs the dev
dependency group. An editable install means your source-code changes take effect
immediately without reinstalling (the equivalent of pip install -e .). To also
install the documentation tooling:
Running Without Installation¶
You can also run janito directly from the synced environment:
Verify Installation¶
Check that janito is installed correctly:
Or run the help command:
Dependencies¶
janito requires the following dependencies:
| Package | Version | Purpose |
|---|---|---|
openai |
>=1.0.0 | OpenAI API client |
rich |
>=10.0.0 | Rich terminal output |
prompt-toolkit |
>=3.0.0 | Interactive shell |
requests |
>=2.28.0 | HTTP library (MCP support) |
pathspec |
>=0.11.0 | .gitignore-aware file listing |
These are automatically installed when you install janito.
System Requirements¶
- Operating System: Windows, macOS, Linux
- Python: 3.10, 3.11, 3.12, 3.13, 3.14
- Terminal: Any modern terminal (PowerShell, Bash, Zsh, etc.)
Next Steps¶
Now that janito is installed, head to the Quick Start guide to configure and run your first prompt.