---
title: "Documentation"
description: "Official documentation for Caro - your loyal shell companion that converts natural language to POSIX commands"
url: "https://caro.sh/docs"
markdown_url: "https://caro.sh/docs.md"
lang: "en"
type: "website"
image: "https://caro.sh/og/docs.png"
---

# 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](https://caro.sh/docs/installation) - Get Caro running on your system
- [Quick Start](https://caro.sh/docs/quickstart) - Your first commands in minutes
- [Configuration](https://caro.sh/docs/configuration) - Customize Caro for your workflow
- [Meet Kavana](https://caro.sh/docs/kavana) - Install Caro's animated Codex pet or hatch your own

## 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](https://caro.sh/docs/configuration) - Set up your preferences
- [Safety Levels](https://caro.sh/docs/safety) - Understand command validation
- [Model Backends](https://caro.sh/docs/backends) - Configure inference engines

### Reference

- [CLI Reference](https://caro.sh/docs/cli) - Complete command-line options
- [Security](https://caro.sh/docs/security) - Security considerations and best practices

**Need Help?** Join the community on [GitHub Discussions](https://github.com/wildcard/caro/discussions) or report issues on the [issue tracker](https://github.com/wildcard/caro/issues).