Development Status
- 5 - Production/Stable
Intended Audience
- Developers
License
- OSI Approved :: Apache Software License
Operating System
- OS Independent
Programming Language
- Python
- Python :: 3
- Python :: 3.7
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
- Python :: 3.14
- Python :: Implementation :: CPython
- Python :: Implementation :: PyPy
Topic
- Database
The CrateDB Shell (aka Crash) is an interactive command-line interface (CLI) tool for interacting with CrateDB.
Screenshot
Documentation
The official documentation is available at CrateDB shell documentation.
Installation
Python Package
Crash is available as a package from PyPI.
To install the most recent version, run:
pipx install crash
Now, run it:
crash
Standalone
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.
Troubleshooting
The documentation section about troubleshooting connection errors provides support and guidelines how to debug and resolve problems when connecting to CrateDB or CrateDB Cloud.
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? Check out our support channels.
