CLIs and command line tools
>

CLIs

Command line interfaces (CLIs) and tools reference.

Attention

This page documents an earlier version. Go to the latest (v2.3) version.

Note

Information about configuring the YB-Master and YB-TServer services is in the Configuration section.
yb-ctl
Command line utility to easily create and manage local clusters on macOS or Linux.
yb-docker-ctl
Command line utility to easily create and manage Docker-based local clusters.
ysqlsh
CLI shell for interacting with YugabyteDB using YSQL.
ycqlsh
CLI shell for interacting with YugabyteDB using YCQL.
yb-admin
CLI for administering YugabyteDB clusters.
yb-ts-cli
Command line tool for advanced operations on tablet servers.
ysql_dump
Extract a YugabyteDB database into a SQL script file.
ysql_dumpall
Extract all YugabyteDB databases into a SQL script file.