> ## Documentation Index
> Fetch the complete documentation index at: https://docs.opsh.dxu.one/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome to opsh

> Opsh is a natural-language shell adapter for macOS and Linux that translates plain English into shell commands using your choice of AI provider.

Opsh is a natural-language shell adapter for macOS and Linux. Instead of memorizing exact command syntax, you describe what you want in plain English — Opsh translates your request into a shell command using an AI provider of your choice, shows you exactly what it will run, and asks for your confirmation before executing anything.

## What Opsh does

When you open a terminal with Opsh installed, it starts automatically and gives you an interactive prompt. You type a task in natural language — like "find all log files older than 7 days" — and Opsh sends that request to your configured AI provider. The provider returns a shell command. Opsh shows you the command, a brief explanation, and a risk classification, then waits for you to confirm before running anything.

You stay in control at every step. Opsh never runs a command without showing it to you first (unless you enable warp mode, which auto-runs commands classified as safe).

## Key benefits

* **No syntax memorization** — describe tasks in plain English instead of looking up flags and options
* **Transparent execution** — every generated command is shown with an explanation and risk level before it runs
* **Multiple AI providers** — choose OpenAI, Anthropic, Gemini, OpenRouter, or run a local model via Ollama
* **Shell history context** — Opsh reads your recent command history to generate more relevant suggestions
* **Warp mode** — automatically runs safe commands and summarizes the output in plain English
* **Print-only mode** — preview generated commands without executing them, useful for scripting and auditing

## Supported platforms and shells

| Platform | Architectures |
| -------- | ------------- |
| macOS    | arm64, x64    |
| Linux    | arm64, x64    |

Opsh works with **bash** and **zsh**. It detects your shell automatically on startup, and you can override this with `--shell zsh` or `--shell bash` at any time.

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/installation">
    Install Opsh on macOS or Linux with a single curl command.
  </Card>

  <Card title="Quick Start" icon="bolt" href="/quickstart">
    Set up your AI provider and run your first natural-language command in minutes.
  </Card>

  <Card title="Configuration" icon="settings" href="/configuration/overview">
    Configure your AI provider, model, shell preference, and execution behavior.
  </Card>

  <Card title="Warp Mode" icon="rocket" href="/usage/warp-mode">
    Let Opsh auto-run safe commands and summarize results in plain English.
  </Card>
</CardGroup>

<Note>
  Opsh requires an API key from a supported AI provider — OpenAI, Anthropic, Gemini, or OpenRouter. If you prefer to keep everything local, Opsh also supports [Ollama](https://ollama.com), which runs models on your own machine with no API key required.
</Note>