8000 GitHub - psychedel/janito: A Language-Driven Software Development Assistant powered by Claude AI
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

psychedel/janito

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

28 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ€– Janito

Janito is a powerful AI-assisted command-line interface (CLI) tool built with Python, leveraging Anthropic's Claude for intelligent code and file management.

GitHub Repository

✨ Features

  • 🧠 Intelligent AI assistant 8000 powered by Claude
  • πŸ“ File management capabilities with real-time output
  • πŸ” Smart code search and editing
  • πŸ’» Interactive terminal interface with rich formatting
  • πŸ“Š Detailed token usage tracking and cost reporting with cache savings analysis
  • 🌐 Web page fetching with content extraction capabilities
  • πŸ”„ Parameter profiles for optimizing Claude's behavior for different tasks
  • πŸ“‹ Line delta tracking to monitor net changes in files
  • πŸ’¬ Enhanced conversation history with browsing and management
  • πŸ”‡ Trust mode for concise output without tool details
  • 🚫 No-tools mode for pure AI interactions without file system access
  • πŸ“ Custom system instructions for specialized assistant behavior

πŸ› οΈ System Requirements

  • Python 3.8+ - Janito requires Python 3.8 or higher
  • Operating Systems:
    • Linux/macOS: Native support
    • Windows: Requires Git Bash for proper operation of CLI tools
  • Anthropic API Key - Required for Claude AI integration

πŸ› οΈ Installation

# Install directly from PyPI
pip install janito

Setting up your API Key

Janito requires an Anthropic API key to function. You can:

  1. Set the API key: janito --set-api-key your_api_key

For development or installation from source, please see README_DEV.md.

πŸš€ Usage Tutorial

After installation, you can start using Janito right away. Let's walk through a simple tutorial:

Getting Started

First, let's check that everything is working:

# Get help and see available commands
janito --help

Tutorial: Creating a Simple Project

Let's create a simple HTML project with Janito's help:

After installing Janito, using your prefered editor and/or terminal, go to a new empty folder.

Use the janito command to create a new project.

# Step 1: Create a new project structure
janito "Create a simple HTML page with a calculator and 3 columns with text for the 3 main activities of the Kazakh culture"

Browse the resulting html page.

Tutorial: Adding Features

Now, let's enhance our example

# Step 2: Add multiplication and division features
janito "Add some svg icons and remove the calculator"

Refresh the page

Exploring More Features

Janito offers many more capabilities:

# Show detailed token usage and cost information
janito --show-tokens "Explain what is in the project"

# Use a specific parameter profile for creative tasks
janito --profile creative "Write a fun description for our project"

# Use trust mode for concise output without tool details
janito --trust "Optimize the HTML code"
# Or use the short alias
janito -t "Optimize the HTML code"

# Disable all tools for pure AI interaction
janito --no-tools "Explain how HTML works"

# View your conversation history
janito --history

# View a specific number of recent conversations
janito --history 10

# Continue the most recent conversation
janito --continue "Please add one more line"

# Continue a specific conversation using its message ID
# (Janito displays the message ID after each conversation)
janito --continue 'abc123def' 'Let's refine that code'

# Alternative way to continue a specific conversation
janito --continue-id abc123def "Let's refine that code"

# Provide custom system instructions
janito --system "You are a poetry expert who speaks in rhymes" "Write about coding"
# Or use the short alias
janito -s "You are a poetry expert who speaks in rhymes" "Write about coding"

# Show current configuration and available profiles
janito --show-config

# You can press Ctrl+C at any time to interrupt a query
# Interrupted conversations can be continued with --continue

πŸ”§ Available Tools

Janito comes with several built-in tools:

  • πŸ“„ str_replace_editor - View, create, and edit files
  • πŸ”Ž find_files - Find files matching patterns
  • πŸ—‘οΈ delete_file - Delete files
  • πŸ” search_text - Search for text patterns in files
  • 🌐 fetch_webpage - Fetch and extract content from web pages
  • πŸ“‹ move_file - Move files from one location to another
  • πŸ’» bash - Execute bash commands with real-time output display

πŸ“Š Usage Tracking

Janito includes a comprehensive token usage tracking system that helps you monitor API costs:

  • Basic tracking: By default, Janito displays a summary of token usage and cost after each query
  • Detailed reporting: Use the --show-tokens flag to see detailed breakdowns including:
    • Input and output token counts
    • Per-tool token usage statistics
    • Precise cost calculations
    • Cache performance metrics with savings analysis
    • Line delta tracking for file modifications
# Show detailed token usage and cost information
janito --show-tokens "Write a Python function to sort a list"

# Basic usage (shows simplified token usage summary)
janito "Explain Docker containers"

# Use trust mode for concise output without tool details
janito --trust "Create a simple Python script"
# Or use the short alias
janito -t "Create a simple Python script"

The usage tracker automatically calculates cache savings, showing you how much you're saving by reusing previous responses.

πŸ“‹ Parameter Profiles

Janito offers predefined parameter profiles to optimize Claude's behavior for different tasks:

  • precise: Factual answers, documentation, structured data (temperature: 0.2)
  • balanced: Professional writing, summarization, everyday tasks (temperature: 0.5)
  • conversational: Natural dialogue, educational content (temperature: 0.7)
  • creative: Storytelling, brainstorming, marketing copy (temperature: 0.9)
  • technical: Code generation, debugging, technical problem-solving (temperature: 0.3)
# Use a specific profile
janito --profile creative "Write a poem about coding"

# View available profiles
janito --show-config

πŸ”‡ Trust Mode

Janito offers a trust mode that suppresses tool outputs for a more concise execution experience:

How It Works

  • When enabled with --trust or -t, Janito suppresses informational and success messages from tools
  • Only essential output and error messages are displayed
  • The final result from Claude is still shown in full
  • Trust mode is a per-session setting and not saved to your configuration

Using Trust Mode

# Enable trust mode with the full flag
janito --trust "Create a Python script that reads a CSV file"

# Or use the short alias
janito -t "Create a Python script that reads a CSV file"

This feature is particularly useful for:

  • Experienced users who don't need to see every step of the process
  • Batch processing or scripting where concise output is preferred
  • Focusing on results rather than the process
  • Creating cleaner output for documentation or sharing

🚫 No-Tools Mode

Janito provides a no-tools mode that disables all file system and external tools for pure AI interactions:

How It Works

  • When enabled with --no-tools, Janito disables all tools for the current session
  • Claude will respond based purely on its knowledge without accessing or modifying files
  • This mode is a per-session setting and not saved to your configuration

Using No-Tools Mode

# Enable no-tools mode
janito --no-tools "Explain how Docker containers work"

This feature is particularly useful for:

  • Getting general information or explanations without file system access
  • Brainstorming sessions where you don't need file operations
  • Safer operation in sensitive environments
  • Faster responses for queries that don't require tools

πŸ“ Custom System Instructions

Janito allows you to provide custom system instructions to change Claude's behavior:

How It Works

  • When provided with --system or -s, Janito uses your custom instructions instead of the default
  • This allows you to create specialized assistant personalities or behaviors
  • Custom instructions are a per-session setting and not saved to your configuration

Using Custom System Instructions

# Provide custom system instructions
janito --system "You are a poetry expert who speaks in rhymes" "Write about coding"

# Or use the short alias
janito -s "You are a cybersecurity expert" "Review this authentication code"

This feature is particularly useful for:

  • Creating specialized assistant personalities
  • Focusing Claude on specific domains or expertise
  • Setting up specific response formats or styles
  • Educational scenarios where you need different expert perspectives

πŸ’¬ Conversation History

Janito automatically saves your conversation history, allowing you to browse, manage, and continue previous discussions:

How It Works

  • Each conversation is saved with a unique message ID in .janito/last_messages/
  • The most recent conversation is also saved as .janito/last_message.json for backward compatibility
  • After each conversation, Janito displays the command to continue that specific conversation

Browsing Your History

You can view your conversation history with the --history flag:

# Show the 20 most recent conversations (default)
janito --history

# Show a specific number of recent conversations
janito --history 10

This displays a table with:

  • Conversation ID
  • Date and time
  • First query from each conversation

Using the Continue Feature

# Continue the most recent conversation
janito --continue "Add more details to your previous response"

# Continue a specific conversation using its ID
janito --continue abc123def "Let's modify that code you suggested"

# Just use --continue without arguments to continue the most recent conversation
# and be prompted for your next query
janito --continue

# Alternative way to continue a specific conversation
janito --continue-id abc123def "Let's modify that code you suggested"

The --continue flag (or -c for short) allows you to:

  • Resume the most recent conversation when used without an ID
  • Resume a specific conversation when provided with a message ID
  • Maintain context across multiple interactions for complex tasks

This feature is particularly useful for:

  • Multi-step development tasks
  • Iterative code improvements
  • Continuing discussions after system interruptions
  • Maintaining context when working on complex problems

βš™οΈ Dependencies

Janito automatically installs the following dependencies:

  • typer (>=0.9.0) - For CLI interface
  • rich (>=13.0.0) - For rich text formatting
  • claudine - For Claude AI integration
  • Additional packages for file handling and web content extraction

πŸ› οΈ Command-Line Options

Janito offers a variety of command-line options to customize its behavior:

--verbose, -v                 Enable verbose mode with detailed output
--show-tokens                 Show detailed token usage and pricing information
--workspace, -w TEXT          Set the workspace directory
--set-config TEXT             Configuration string in format 'key=value', e.g., 'temperature=0.7'
--show-config                 Show current configuration
--reset-config                Reset configuration by removing the config file
--set-api-key TEXT            Set the Anthropic API key globally in the user's home directory
--ask                         Enable ask mode which disables tools that perform changes
--trust, -t                   Enable trust mode which suppresses tool outputs for concise execution
--no-tools                    Disable all tools for this session (pure AI interaction)
--temperature FLOAT           Set the temperature for model generation (0.0 to 1.0)
--profile TEXT                Use a predefined parameter profile (precise, balanced, conversational, creative, technical)
--role TEXT                   Set the assistant's role (default: 'software engineer')
--system, -s TEXT             Provide custom system instructions, bypassing the default file load method
--version                     Show the version and exit
--continue, -c TEXT           Continue a conversation. Can be used as: 1) --continue (to continue most recent), 
                              2) --continue 123 (to continue conversation with ID 123), or 
                              3) --continue "query" (to continue most recent with new query)
--continue-id TEXT            Continue a specific conversation with the given ID
--history                     Show a summary of conversations. Use --history for default (20) or --history n to specify count
--help                        Show the help message and exit

πŸ”‘ API Key Configuration

You can configure your Anthropic API key in several ways:

# Option 1: Set as environment variable
export ANTHROPIC_API_KEY=your_api_key

# Option 2: Configure globally within Janito
janito --set-api-key your_api_key

# Option 3: Let Janito prompt you on first use
janito "Hello, I'm new to Janito!"

Your API key is securely stored and used for all future sessions.

πŸ’» Development

For development instructions, please refer to README_DEV.md.

πŸ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A Language-Driven Software Development Assistant powered by Claude AI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 97.0%
  • Shell 3.0%
0