Skip to main content

​
Usage

capsule doctor

​
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

SymbolMeaning
✓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