.. image:: https://github.com/crate/crash/actions/workflows/main.yml/badge.svg :target: https://github.com/crate/crash/actions/workflows/main.yml :alt: Outcome of CI
.. image:: https://img.shields.io/pypi/v/crash.svg :target: https://pypi.python.org/pypi/crash :alt: Most recent version on PyPI
.. image:: https://img.shields.io/pypi/pyversions/crash.svg :target: https://pypi.python.org/pypi/crash :alt: Supported Python versions
.. image:: https://img.shields.io/github/license/crate/crash :target: https://github.com/crate/crash/blob/master/LICENSE :alt: License
.. image:: https://static.pepy.tech/badge/crash/month :target: https://www.pepy.tech/projects/crash :alt: Number of downloads per month
|
The CrateDB Shell (aka Crash) is an interactive command-line interface
_
(CLI) tool for interacting with CrateDB.
.. image:: https://raw.githubusercontent.com/crate/crash/master/docs/query.png :alt: A screenshot of Crash
The official documentation is available at CrateDB shell documentation
_.
Crash is available as a pip
_ package.
To install, run::
pip install crash
Now, run it::
crash
To update, run::
pip install -U crash
Crash is also available as a standalone executable that includes all the necessary dependencies.
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
_.
The documentation section about troubleshooting connection errors
provides
support and guidelines how to debug and resolve problems when connecting to
CrateDB
or CrateDB Cloud
_.
This project is primarily maintained by Crate.io_, but we welcome community contributions!
See the developer docs
and the contribution docs
for more information.
Looking for more help? Check out our support channels
_.
.. _command-line interface: https://en.wikipedia.org/wiki/Command-line_interface .. _contribution docs: CONTRIBUTING.rst .. _Crate.io: https://cratedb.com/ .. _CrateDB: https://github.com/crate/crate .. _CrateDB Cloud: https://console.cratedb.cloud .. _CrateDB shell documentation: https://cratedb.com/docs/crate/crash/ .. _developer docs: DEVELOP.rst .. PATH: https://en.wikipedia.org/wiki/PATH(variable) .. _pip: https://pypi.python.org/pypi/pip .. _support channels: https://cratedb.com/support/ .. _troubleshooting connection errors: https://cratedb.com/docs/crate/crash/en/latest/troubleshooting.html