Caro Documentation

Welcome to the Caro documentation. Caro is your loyal shell companion that converts natural language descriptions into safe, POSIX-compliant shell commands using local language models.

Getting Started

New to Caro? Start here:

• Installation - Get Caro running on your system
• Quick Start - Your first commands in minutes
• Configuration - Customize Caro for your workflow

Quick Example

# Ask Caro to generate a command
$ caro "find all Python files modified in the last week"

Command:
  find . -name "*.py" -mtime -7

Execute this command? [y/N]

Key Features

• Natural Language Input - Describe what you want in plain English
• Safety First - Built-in validation blocks dangerous commands
• POSIX Compliant - Commands work across Unix-like systems
• Local LLMs - Your data stays on your machine
• Multiple Backends - MLX for Apple Silicon, Ollama, and more

Documentation Sections

Guides

• Configuration - Set up your preferences
• Safety Levels - Understand command validation
• Model Backends - Configure inference engines

Reference

• CLI Reference - Complete command-line options
• Security - Security considerations and best practices