The Crate Data Shell


Keywords
crate db data client shell
License
Apache-2.0
Install
pip install crash==0.24.0

Documentation

The CrateDB Shell

Travis CI Version Documentation Coverage

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

Screenshot

A screenshot of Crash

Prerequisites

Recent versions of Crash require Python 3 (>= 3.4) to run.

Use Crash version 0.23.x if you are running Python 2.7 or 3.3.

Use Crash version 0.16.x if you're running Python 2.6.

Installation

Under normal circumstances, you do not have to manually install Crash.

Crash is bundled with CrateDB so there is typically no need to install it yourself.

If you are able to run the crate command, you should be able to run the crash command (either from the same bin directory, or on your PATH).

The following instructions should only be followed if you specifically want to install Crash separately from CrateDB.

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.4 or above, recent version of pip will only install version 0.23.x. This is because newer versions of this package are not compatible with Python 2.7 or 3.3 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.4) 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.

Legacy Versions

For Python 2.7 and 3.3 please download version 0.23.0 from the CDN:

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

For Python 2.6 please download version 0.16.2 from the CDN:

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

Usage

For usage information and options, run:

$ crash --help

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?