> ## Documentation Index
> Fetch the complete documentation index at: https://doc.trycapsule.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# capsule doctor

> Check that all required database tools are installed and available.

## Usage

```bash theme={null}
capsule doctor
```

## When to run this

| Situation                                        | Why                                                                                               |
| ------------------------------------------------ | ------------------------------------------------------------------------------------------------- |
| After first installing Capsule                   | Confirms the right tools (`pg_dump`, `mysqldump`, etc.) are present before your first backup runs |
| After adding a new database connection type      | Checks that the tools for that engine are installed                                               |
| After a backup fails with a tool-not-found error | Diagnoses which binary is missing and shows how to install it                                     |
| After upgrading the OS or reinstalling packages  | Verifies the tools survived the change                                                            |

## What it does

`capsule doctor` inspects your environment and reports whether the native database tools Capsule needs are installed and available in your `PATH`.

It checks tools for every database type you have connections configured for. Database types with no connections are shown as inactive and never flagged as issues.

## Output

```
Dependency Check

  postgres   (2 connections)   ✓ pg_dump   ✓ psql
  mysql      (0 connections)   – mysqldump   – mysql   · not in use
  mongo      (1 connection)    ✓ mongodump   ✓ mongosh   ✓ mongorestore

✓ All dependencies satisfied. Capsule is ready.
```

### Status indicators

| Symbol | Meaning                                       |
| ------ | --------------------------------------------- |
| `✓`    | Tool found in PATH — ready                    |
| `✗`    | Tool missing — issue reported below the table |
| `–`    | Database type not in use — no action needed   |

## When issues are found

If a required tool is missing, `capsule doctor` prints the issue and install instructions after the table:

```
Issues Found

  ✗ postgres
    Install with:
    sudo apt-get install postgresql-client
```

## Install instructions by OS

`capsule doctor` detects your OS and shows the appropriate package manager command — `apt-get` on Debian/Ubuntu, `yum` on RHEL/CentOS/Amazon Linux, `brew` on macOS.

## Docker connections

If all connections for a given database type use Docker, the host-side binaries are not needed. Those entries show as `(container)` instead of individual binary checks.

If any connection uses Docker, `capsule doctor` also checks that the `docker` binary is available in `PATH`.

## Notes

* `capsule doctor` does not require authentication — you can run it on a fresh install before `capsule auth`
* Run it after installing new database tools to confirm they are picked up correctly