Documentation

Learn ShellPilot

Everything you need to master the command line with AI.

Getting Started

Quick start guide to get ShellPilot up and running in minutes.

Basic Usage

Learn the fundamentals of using natural language commands.

Configuration

Customize ShellPilot to match your workflow and preferences.

Plugins

Extend functionality with our growing plugin ecosystem.

API Reference

Complete API documentation for developers and integrations.

FAQ

Answers to commonly asked questions about ShellPilot.

Getting Started

1. Install ShellPilot

Install ShellPilot using our one-line installer:

curl -sSL shellpilot.pro/install | sh

2. Authenticate

Sign in to your account to enable cloud features:

shellpilot auth login

3. Start Using

Ask ShellPilot anything in natural language:

shellpilot "find all large files over 100MB"

Basic Usage

ShellPilot understands natural language and converts it to shell commands. Simply describe what you want to do, and ShellPilot will generate the appropriate command.

Example Commands

  • "List all running docker containers"docker ps
  • "Find files modified in the last hour"find . -mmin -60 -type f
  • "Compress this folder and upload to S3"tar -czf archive.tar.gz . && aws s3 cp archive.tar.gz s3://bucket/

Configuration

Customize ShellPilot through the configuration file at ~/.shellpilot/config.yaml.

Frequently Asked Questions

Is my data secure?

Yes. ShellPilot processes commands locally by default. Cloud features use end-to-end encryption and we never store your command history.

Which shells are supported?

ShellPilot supports Bash, Zsh, Fish, and PowerShell. More shells are being added based on user feedback.

Can I use my own AI model?

Yes! Pro users can configure custom models including local LLMs through our plugin system.