janito 0.6.0

A CLI tool for software development tasks powered by AI

Janito

AI-powered CLI tool for code modifications and analysis. Janito helps you modify, analyze, and understand your codebase using natural language commands.

Table of Contents

• Features
• Installation
  • Prerequisites
  • Steps
• Usage
  • Basic Commands
  • Common Use Cases
• Configuration
  • Environment Variables
  • Command Line Options
• Troubleshooting
  • Common Issues
  • Error Messages
• Contributing
• License

✨ Features

• Natural language code modifications
• Codebase analysis and question answering
• Smart search and replace with indentation awareness
• Git-aware operations
• Interactive shell mode
• Change preview and validation
• Automatic backup and restore

🚀 Installation

Prerequisites

• Python 3.8 or higher
• pip package manager
• An Anthropic API key (default) or OpenAI API key

Steps

1. Install using pip:

pip install janito

2. Configure your API key:

For Anthropic Claude (default):

export ANTHROPIC_API_KEY=your_api_key_here

For OpenAI:

export OPENAI_API_KEY=your_api_key_here
export AI_BACKEND=openai

💡 Usage

Basic Commands

# Modify code
janito "add docstrings to this file"

# Ask questions about the codebase
janito --ask "explain the main function in this file"

# Preview files that would be analyzed
janito --scan

# Start interactive shell
janito

Common Use Cases

1. Code Documentation:

janito "add type hints to all functions"
janito "improve docstrings with more details"

2. Code Analysis:

janito --ask "what are the main classes in this project?"
janito --ask "explain the error handling flow"

3. Code Refactoring:

janito "convert this class to use dataclasses"
janito "split this large function into smaller ones"

⚙️ Configuration

Environment Variables

• ANTHROPIC_API_KEY: Anthropic API key
• OPENAI_API_KEY: OpenAI API key (if using OpenAI backend)
• AI_BACKEND: AI provider ('claudeai' or 'openai')
• JANITO_TEST_CMD: Default test command to run after changes

Command Line Options

• -w, --workspace_dir: Set working directory
• -i, --include: Additional paths to include
• --debug: Show debug information
• --verbose: Show verbose output
• --auto-apply: Apply changes without confirmation
• --history: Display history of requests

🔧 Troubleshooting

Common Issues

1. API Key Issues:

# Verify API key is set
echo $ANTHROPIC_API_KEY

# Temporarily set API key for single command
ANTHROPIC_API_KEY=your_key janito "your request"

2. Path Issues:

# Use absolute paths if having issues with relative paths
janito -w /full/path/to/project "your request"

# Specify additional paths explicitly
janito -i ./src -i ./tests "your request"

3. Debug Mode:

# Enable debug output for troubleshooting
janito --debug "your request"

Error Messages

• "No command given": Provide a change request or command
• "No input provided": Check if using --input mode correctly
• "Duplicate path provided": Remove duplicate paths from includes

👥 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

MIT License - see LICENSE