README.rst

The CrateDB Shell

The CrashDB Shell (aka Crash) is an interactive command-line interface (CLI) tool for interacting with CrateDB.

Screenshot

Installation

Python Package

Crash is available as a pip package.

To install, run:

$ pip install crash

Now, run it:

$ crash

To update, run:

$ pip install -U crash

If you are not using Python version 3.5 or above, recent version of pip will install an earlier version of Crash. This is because newer versions of this package are not compatible with Python 2.7 or 3.4 and below.

Standalone

Crash is also available as a standalone executable that includes all the necessary dependencies, and can be run as long as Python (>= 3.5) is available on your system.

First, download the executable file:

$ curl -o crash https://cdn.crate.io/downloads/releases/crash_standalone_latest

Then, set the executable bit:

$ chmod +x crash

Now, run it:

$ ./crash

If you would like to run crash from any directory, and without the leading ./, the file has to be in a directory that is on your PATH.

Contributing

This project is primarily maintained by Crate.io, but we welcome community contributions!

See the developer docs and the contribution docs for more information.

Help

Looking for more help?

• Read the project docs
• Check out our support channels