Skip to main content

OpenAI CLI with Function Calling, MCP Support, and Extensible Tools

Project description

janito - an OpenAI CLI with function calling and MCP

📖 Full documentation available at https://ikignosis.org/janito/

Features

  • 🔧 Function Calling - Built-in tools for file operations, web search, and more
  • 📧 Gmail Integration - Read, search, and manage emails
  • ☁️ OneDrive Integration - Browse, upload, download, and share files
  • 🔌 MCP Support - Connect to Model Context Protocol servers
  • 🧩 Skills - Install and use task-specific skills from GitHub
  • 📊 Real-time Progress - Watch tool execution progress as it happens
  • 🚀 Easy Setup - Interactive configuration with --config or quick setup with --set flags
  • 🔗 Any OpenAI-Compatible API - Works with OpenAI, local servers (LM Studio, Ollama), and custom endpoints

Quick Start

# Install
pip install janito

# Configure interactively
janito --config

# Or set options directly
janito --set provider=openai --set-api-key="sk-your-key" --set model=gpt-4

# Start chatting
janito "Hello!"

Installation

From PyPI

pip install janito

For development setup, see README_DEV.md.

Configuration

Interactive Setup

janito --config

You'll be prompted for:

  • Provider - openai or custom
  • API Key - Masked for security
  • Model - e.g., gpt-4, gpt-3.5-turbo
  • Context Window - Max tokens (default: 65536)

Quick Configuration with --set

Set options directly from the command line:

# Set the provider
janito --set provider=openai

# Set your API key
janito --set-api-key="sk-your-key-here"

# Set the model
janito --set model=gpt-4

# Combine multiple options
janito --set provider=openai --set model=gpt-4 --set-api-key="sk-your-key"

View Configuration

janito --show-config

Available Options

Option Description Example
provider Provider name openai, custom
model Model name gpt-4, claude-3-opus
context-window Context window size 65536

For custom endpoints (base-url), see README_LOCAL.md.

Usage

Single Prompt

janito "What is the capital of France?"

Pipe Input

echo "Tell me a joke" | janito

Interactive Chat

janito

Commands in chat mode:

  • exit / quit - End session
  • restart - Clear conversation history
  • Ctrl+D / Ctrl+Z - Exit

Logging

janito --log=info "Your prompt"      # Info level
janito --log=debug "Your prompt"     # Debug level
janito --log=info,debug "Your prompt" # Multiple levels

Examples

OpenAI

janito --set provider=openai --set-api-key="sk-your-key" --set model=gpt-4 "Explain quantum computing"

Built-in Tools

janito includes tools for common tasks:

Email Integration (Gmail)

# Use Gmail in chat mode
janito --gmail

# Check emails
janito --gmail "Show my unread emails from today"

For full Gmail documentation, see README.gmail.md.

Cloud Storage (OneDrive)

# Authenticate with Microsoft OneDrive
janito --onedrive-auth

# Use OneDrive in chat mode
janito --onedrive

# List files
janito --onedrive "List my files in Documents"

For full OneDrive documentation, see README.onedrive.md.

File Operations

# List files
janito.tools.files.list_files . --recursive --pattern "*.py"

# Read file
janito.tools.files.read_file README.md --max-lines 20

MCP Tools

Connect to MCP servers using the /mcp command inside the interactive shell:

# Add a stdio-based MCP server
/mcp add myserver stdio python -m mcp.server

# Add an HTTP-based MCP server
/mcp add remote http https://api.example.com/mcp

# List configured servers
/mcp list

For full MCP documentation, see README_MCP.md.

Tool Progress Reporting

Tools report progress in real-time:

🔄 Reading files...
📊 Processing: 50/100 files
✅ Completed: 100 files (2.3MB)

Progress messages go to stderr so they don't interfere with tool output.

Error Handling

Exit Code Meaning
0 Success
1 Configuration or runtime error
130 User cancelled (Ctrl+C)

Dependencies

  • Python 3.6+
  • openai>=1.0.0
  • rich>=10.0.0
  • prompt-toolkit>=3.0.0
  • requests (for MCP support)

License

MIT License

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

janito-4.1.1.tar.gz (134.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

janito-4.1.1-py3-none-any.whl (169.0 kB view details)

Uploaded Python 3

File details

Details for the file janito-4.1.1.tar.gz.

File metadata

  • Download URL: janito-4.1.1.tar.gz
  • Upload date:
  • Size: 134.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for janito-4.1.1.tar.gz
Algorithm Hash digest
SHA256 47cd0d16b992849fc77fec65928c8cf835352015bdfda36ca54d7ccfdf24c8d7
MD5 797df16c2c83636b3dabd979a5a33cd8
BLAKE2b-256 fb7db444e9fb1ecdc68479696f9b5893d636d3e0ce047fb0c96150406409f1ff

See more details on using hashes here.

File details

Details for the file janito-4.1.1-py3-none-any.whl.

File metadata

  • Download URL: janito-4.1.1-py3-none-any.whl
  • Upload date:
  • Size: 169.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for janito-4.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a0bb388bfe7ce95cd38e5089f812736390a5cf176c274a7e52a9c91dd6712de5
MD5 00931bfa049bb77fc3ac36c19b3a6367
BLAKE2b-256 5effc512026fbcecdca2a583452ccdcb9bf03e0e3262e8e57f5d04b487d77107

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page