OS Manuals

/usr/bin/cqlsh

From cqlsh-5.0 5.0.8-r1 (os), captured 2026-11-05 by running cqlsh --help (exit 0). permalink

Also provided by 2 other package versions
usage: Usage: cqlsh [options] [host [port]]

CQL Shell for Apache Cassandra

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -C, --color           Always use color output
  --no-color            Never use color output
  --browser BROWSER     The browser to use to display CQL help, where BROWSER can be: - one of the
                        supported browsers in https://docs.python.org/3/library/webbrowser.html. -
                        browser path followed by %s, example: /usr/bin/google-chrome-stable %s
  --ssl                 Use SSL
  -u USERNAME, --username USERNAME
                        Authenticate as user.
  -p PASSWORD, --password PASSWORD
                        Authenticate using password.
  -k KEYSPACE, --keyspace KEYSPACE
                        Authenticate to the given keyspace.
  -f FILE, --file FILE  Execute commands from FILE, then exit
  --debug               Show additional debugging information
  --coverage            Collect coverage data
  --encoding ENCODING   Specify a non-default encoding for output. (Default: utf-8)
  --cqlshrc CQLSHRC     Specify an alternative cqlshrc file location.
  --credentials CREDENTIALS
                        Specify an alternative credentials file location.
  --cqlversion CQLVERSION
                        Specify a particular CQL version, by default the highest version supported
                        by the server will be used. Examples: "3.0.3", "3.1.0"
  --protocol-version PROTOCOL_VERSION
                        Specify a specific protcol version otherwise the client will default and
                        downgrade as necessary
  -e EXECUTE, --execute EXECUTE
                        Execute the statement and quit.
  --connect-timeout CONNECT_TIMEOUT
                        Specify the connection timeout in seconds (default: 5 seconds).
  --request-timeout REQUEST_TIMEOUT
                        Specify the default request timeout in seconds (default: 10 seconds).
  -t, --tty             Force tty mode (command prompt).
  --disable-history     Disable saving of history (existing history will still be loaded)

Connects to 127.0.0.1:9042 by default. These defaults can be changed by setting $CQLSH_HOST and/or
$CQLSH_PORT. When a host (and optional port number) are given on the command line, they take
precedence over any defaults.
Options (18)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
-v, --versionshow program's version number and exithelp
-C, --colorAlways use color outputhelp
--no-colorNever use color outputhelp
--browser BROWSERThe browser to use to display CQL help, where BROWSER can be: - one of the supported browsers in https://docs.python.org/3/library/webbrowser.html.help
--sslUse SSLhelp
-f, --file FILEExecute commands from FILE, then exithelp
--debugShow additional debugging informationhelp
--coverageCollect coverage datahelp
--encoding ENCODINGSpecify a non-default encoding for output.help
--cqlshrc CQLSHRCSpecify an alternative cqlshrc file location.help
--credentials CREDENTIALSSpecify an alternative credentials file location.help
--cqlversion CQLVERSIONSpecify a particular CQL version, by default the highest version supported by the server will be used.help
--protocol-version PROTOCOL_VERSIONSpecify a specific protcol version otherwise the client will default and downgrade as necessaryhelp
--connect-timeout CONNECT_TIMEOUTSpecify the connection timeout in seconds (default: 5 seconds).help
--request-timeout REQUEST_TIMEOUTSpecify the default request timeout in seconds (default: 10 seconds).help
-t, --ttyForce tty mode (command prompt).help
--disable-historyDisable saving of history (existing history will still be loaded)help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.