=================
The CrateDB Shell
=================
.. 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.
Screenshot
==========
.. image:: https://raw.githubusercontent.com/crate/crash/master/docs/query.png
:alt: A screenshot of Crash
Documentation
=============
The official documentation is available at `CrateDB shell documentation`_.
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
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`_.
.. _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
Raw data
{
"_id": null,
"home_page": "https://github.com/crate/crash",
"name": "crash",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "crate db data client shell",
"author": "Crate.io",
"author_email": "office@crate.io",
"download_url": "https://files.pythonhosted.org/packages/b5/3a/a10ca9caf7ea4cffd1a2fc0a0074b887daf011ebe080e00c70283d7b2cca/crash-0.31.5.tar.gz",
"platform": "any",
"description": "=================\nThe CrateDB Shell\n=================\n\n.. image:: https://github.com/crate/crash/actions/workflows/main.yml/badge.svg\n :target: https://github.com/crate/crash/actions/workflows/main.yml\n :alt: Outcome of CI\n\n.. image:: https://img.shields.io/pypi/v/crash.svg\n :target: https://pypi.python.org/pypi/crash\n :alt: Most recent version on PyPI\n\n.. image:: https://img.shields.io/pypi/pyversions/crash.svg\n :target: https://pypi.python.org/pypi/crash\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/github/license/crate/crash\n :target: https://github.com/crate/crash/blob/master/LICENSE\n :alt: License\n\n.. image:: https://static.pepy.tech/badge/crash/month\n :target: https://www.pepy.tech/projects/crash\n :alt: Number of downloads per month\n\n|\n\nThe CrateDB Shell (aka *Crash*) is an interactive `command-line interface`_\n(CLI) tool for interacting with CrateDB.\n\nScreenshot\n==========\n\n.. image:: https://raw.githubusercontent.com/crate/crash/master/docs/query.png\n :alt: A screenshot of Crash\n\n\nDocumentation\n=============\nThe official documentation is available at `CrateDB shell documentation`_.\n\n\nInstallation\n============\n\nPython Package\n--------------\n\nCrash is available as a `pip`_ package.\n\nTo install, run::\n\n pip install crash\n\nNow, run it::\n\n crash\n\nTo update, run::\n\n pip install -U crash\n\nStandalone\n----------\n\nCrash is also available as a standalone executable that includes all the\nnecessary dependencies.\n\nFirst, download the executable file::\n\n curl -o crash https://cdn.crate.io/downloads/releases/crash_standalone_latest\n\nThen, set the executable bit::\n\n chmod +x crash\n\nNow, run it::\n\n ./crash\n\nIf you would like to run ``crash`` from any directory, and without the leading\n``./``, the file has to be in a directory that is on your `PATH`_.\n\nTroubleshooting\n===============\n\nThe documentation section about `troubleshooting connection errors`_ provides\nsupport and guidelines how to debug and resolve problems when connecting to\n`CrateDB`_ or `CrateDB Cloud`_.\n\nContributing\n============\n\nThis project is primarily maintained by Crate.io_, but we welcome community\ncontributions!\n\nSee the `developer docs`_ and the `contribution docs`_ for more information.\n\nHelp\n====\n\nLooking for more help? Check out our `support channels`_.\n\n\n.. _command-line interface: https://en.wikipedia.org/wiki/Command-line_interface\n.. _contribution docs: CONTRIBUTING.rst\n.. _Crate.io: https://cratedb.com/\n.. _CrateDB: https://github.com/crate/crate\n.. _CrateDB Cloud: https://console.cratedb.cloud\n.. _CrateDB shell documentation: https://cratedb.com/docs/crate/crash/\n.. _developer docs: DEVELOP.rst\n.. _PATH: https://en.wikipedia.org/wiki/PATH_(variable)\n.. _pip: https://pypi.python.org/pypi/pip\n.. _support channels: https://cratedb.com/support/\n.. _troubleshooting connection errors: https://cratedb.com/docs/crate/crash/en/latest/troubleshooting.html\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "CrateDB Shell",
"version": "0.31.5",
"project_urls": {
"Homepage": "https://github.com/crate/crash"
},
"split_keywords": [
"crate",
"db",
"data",
"client",
"shell"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb10a8e5b0f3b6895fe40743a42a9be9e6cd3d274977ebf9a614fa577f068ed3",
"md5": "cfd9a79b1705762a25e271ca863b705e",
"sha256": "497042610c39ce24e684d87db5d9cc80b2edd7ef7068d5d23c7700327e3e6f14"
},
"downloads": -1,
"filename": "crash-0.31.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cfd9a79b1705762a25e271ca863b705e",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 37855,
"upload_time": "2024-04-24T18:46:12",
"upload_time_iso_8601": "2024-04-24T18:46:12.704002Z",
"url": "https://files.pythonhosted.org/packages/eb/10/a8e5b0f3b6895fe40743a42a9be9e6cd3d274977ebf9a614fa577f068ed3/crash-0.31.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b53aa10ca9caf7ea4cffd1a2fc0a0074b887daf011ebe080e00c70283d7b2cca",
"md5": "7f38fab1c0b1d274b0b13b4ac4314697",
"sha256": "20eb4b67da451adb389cfbab5766a636d8ed6a863b52955652d638e2dd759eac"
},
"downloads": -1,
"filename": "crash-0.31.5.tar.gz",
"has_sig": false,
"md5_digest": "7f38fab1c0b1d274b0b13b4ac4314697",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 45125,
"upload_time": "2024-04-24T18:46:16",
"upload_time_iso_8601": "2024-04-24T18:46:16.063280Z",
"url": "https://files.pythonhosted.org/packages/b5/3a/a10ca9caf7ea4cffd1a2fc0a0074b887daf011ebe080e00c70283d7b2cca/crash-0.31.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 18:46:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "crate",
"github_project": "crash",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "crash"
}
JSON
