Skip to main content

The Crate Data Shell

Project description

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?

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crash-0.24.1.tar.gz (52.9 kB view details)

Uploaded Source

Built Distribution

crash-0.24.1-py2.py3-none-any.whl (61.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file crash-0.24.1.tar.gz.

File metadata

  • Download URL: crash-0.24.1.tar.gz
  • Upload date:
  • Size: 52.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for crash-0.24.1.tar.gz
Algorithm Hash digest
SHA256 045f8478bb6bd43e8c867c02d5e880ba973c53eed5a553e4e09ed8cbd7ea3f37
MD5 1633ec201ccdf2f1bfc681b2b5274a35
BLAKE2b-256 773c2c2f247c9a5953138d6857959bb45a64ba2e18cd0997e7f626e4394050e0

See more details on using hashes here.

File details

Details for the file crash-0.24.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for crash-0.24.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a6ccd6a2a1d0e6a692647d7040b72dd61df2eb393485491610dad6f4b1e5417c
MD5 8c65b96f93913a1cd1f3af43820ebb9c
BLAKE2b-256 213bce6d2c33c085c930db415c65a441322f0be88f2cfe25acd28d0142372956

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page