Skip to content

Installation

This guide covers how to install janito.

From PyPI

The easiest way to install janito is from PyPI:

pip install janito

From Source

For development or the latest features, install from source:

Prerequisites

  • Python 3.6+
  • Git
  • GitHub CLI (optional)

Clone and Install

# Clone the repository
git clone https://github.com/ikignosis/janito.git
cd janito

# Install dependencies
pip install -r requirements.txt

# Install in development mode
pip install -e .

Running Without Installation

You can also run janito directly without installing:

python -m janito "Your prompt here"

Verify Installation

Check that janito is installed correctly:

janito --version

Or run the help command:

janito --help

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

These are automatically installed when you install janito.

System Requirements

  • Operating System: Windows, macOS, Linux
  • Python: 3.6, 3.7, 3.8, 3.9, 3.10, 3.11+
  • 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.