Skip to content

Using Janito: Quickstart & Basic Usage

This guide explains how to start using Janito after installation. For an overview, see the Introduction. For setup, see the Installation Guide and Configuration Guide.

Quickstart

After installing Janito, you can use it from the command line:

Run a One-Off Prompt

janito "Refactor the data processing module to improve readability."

Start the Interactive Chat Shell

janito

Basic Usage Tips

  • Use natural language to describe what you want Janito to do (e.g., "Add type hints to all functions in utils.py").
  • In the chat shell, use /help for available commands. Use /exec on to enable code/shell execution tools at runtime.
  • Use CLI flags to customize behavior (see CLI Options).
  • Shell commands can be executed using the built-in run_bash_command and run_powershell_command tools (when enabled).

Model and Provider Selection

You can specify which model and provider to use in two ways:

Traditional approach:

janito -p openai -m gpt-4 "Your prompt here"

Shorthand syntax:

janito -m gpt-4@openai "Your prompt here"

The model@provider syntax is particularly useful for quick one-off commands and follows conventions used by tools like Docker.

More Resources