firebolt-cli


Namefirebolt-cli JSON
Version 0.7.0 PyPI version JSON
download
home_pagehttps://github.com/firebolt-db/firebolt-cli
SummaryCLI for Firebolt
upload_time2024-02-05 15:34:14
maintainer
docs_urlNone
authorFirebolt
requires_python>=3.7
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Firebolt-CLI

[![Nightly code check](https://github.com/firebolt-db/firebolt-cli/actions/workflows/nightly.yml/badge.svg)](https://github.com/firebolt-db/firebolt-cli/actions/workflows/nightly.yml)
[![Unit tests](https://github.com/firebolt-db/firebolt-cli/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/firebolt-db/firebolt-cli/actions/workflows/unit-tests.yml)
[![Code quality checks](https://github.com/firebolt-db/firebolt-cli/actions/workflows/code-check.yml/badge.svg)](https://github.com/firebolt-db/firebolt-cli/actions/workflows/code-check.yml)
[![Firebolt Security Scan](https://github.com/firebolt-db/firebolt-cli/actions/workflows/security-scan.yml/badge.svg)](https://github.com/firebolt-db/firebolt-cli/actions/workflows/security-scan.yml)
[![Integration tests](https://github.com/firebolt-db/firebolt-cli/actions/workflows/integration-tests.yml/badge.svg)](https://github.com/firebolt-db/firebolt-cli/actions/workflows/integration-tests.yml)
![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/yuryfirebolt/54357e681f193cee7807a96cb49d7910/raw/firebolt-cli-coverage.json)

Firebolt cli is a tool for connecting to firebolt, managing firebolt resources, and executing queries from the command line.

## Quickstart

For detailed installation and usage instructions, see [Using the CLI](https://docs.firebolt.io/using-the-cli.html) in Firebolt documentation.

### Prerequisites

* `python>=3.7` and `pip` are required. See the [Python web page](https://www.python.org/downloads/).

* Running commands requires an active Firebolt account and a user with privileges to perform operations. For more information, see [Subscribing to Firebolt and creating an account](https://docs.firebolt.io/managing-your-account/creating-an-account.html).

### Installing using pip

```shell
$ pip install firebolt-cli
```

To verify, check the version.

```shell
$ firebolt --version
```

```shell
firebolt, version 0.6.0
```

### Setting configuration parameters

Use the `firebolt configure` command to set configuration defaults. You can override these when using a specific commands. For more information, see [Configuring CLI parameters](https://docs.firebolt.io/using-the-cli.html#configuring-cli-parameters) in Firebolt documentation.

## Interactive query
![Interactive query demo](firebolt-cli-010722.gif)

## Contributing

See: [CONTRIBUTING.MD](https://github.com/firebolt-db/firebolt-cli/tree/main/CONTRIBUTING.MD)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/firebolt-db/firebolt-cli",
    "name": "firebolt-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Firebolt",
    "author_email": "support@firebolt.io",
    "download_url": "https://files.pythonhosted.org/packages/8a/f0/a3af600d38175d1541a57bd2982a24e1d079b8544c03e6ae8a63edd45d14/firebolt_cli-0.7.0.tar.gz",
    "platform": null,
    "description": "# Firebolt-CLI\n\n[![Nightly code check](https://github.com/firebolt-db/firebolt-cli/actions/workflows/nightly.yml/badge.svg)](https://github.com/firebolt-db/firebolt-cli/actions/workflows/nightly.yml)\n[![Unit tests](https://github.com/firebolt-db/firebolt-cli/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/firebolt-db/firebolt-cli/actions/workflows/unit-tests.yml)\n[![Code quality checks](https://github.com/firebolt-db/firebolt-cli/actions/workflows/code-check.yml/badge.svg)](https://github.com/firebolt-db/firebolt-cli/actions/workflows/code-check.yml)\n[![Firebolt Security Scan](https://github.com/firebolt-db/firebolt-cli/actions/workflows/security-scan.yml/badge.svg)](https://github.com/firebolt-db/firebolt-cli/actions/workflows/security-scan.yml)\n[![Integration tests](https://github.com/firebolt-db/firebolt-cli/actions/workflows/integration-tests.yml/badge.svg)](https://github.com/firebolt-db/firebolt-cli/actions/workflows/integration-tests.yml)\n![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/yuryfirebolt/54357e681f193cee7807a96cb49d7910/raw/firebolt-cli-coverage.json)\n\nFirebolt cli is a tool for connecting to firebolt, managing firebolt resources, and executing queries from the command line.\n\n## Quickstart\n\nFor detailed installation and usage instructions, see [Using the CLI](https://docs.firebolt.io/using-the-cli.html) in Firebolt documentation.\n\n### Prerequisites\n\n* `python>=3.7` and `pip` are required. See the [Python web page](https://www.python.org/downloads/).\n\n* Running commands requires an active Firebolt account and a user with privileges to perform operations. For more information, see [Subscribing to Firebolt and creating an account](https://docs.firebolt.io/managing-your-account/creating-an-account.html).\n\n### Installing using pip\n\n```shell\n$ pip install firebolt-cli\n```\n\nTo verify, check the version.\n\n```shell\n$ firebolt --version\n```\n\n```shell\nfirebolt, version 0.6.0\n```\n\n### Setting configuration parameters\n\nUse the `firebolt configure` command to set configuration defaults. You can override these when using a specific commands. For more information, see [Configuring CLI parameters](https://docs.firebolt.io/using-the-cli.html#configuring-cli-parameters) in Firebolt documentation.\n\n## Interactive query\n![Interactive query demo](firebolt-cli-010722.gif)\n\n## Contributing\n\nSee: [CONTRIBUTING.MD](https://github.com/firebolt-db/firebolt-cli/tree/main/CONTRIBUTING.MD)\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "CLI for Firebolt",
    "version": "0.7.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/firebolt-db/firebolt-cli/issues",
        "Homepage": "https://github.com/firebolt-db/firebolt-cli"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eed1828576e10f176121f932cad92b17ff6a88d72da488b86b03067ac2b60932",
                "md5": "6a4b35d4a76c1fe71b3095c9834990b6",
                "sha256": "d134843beacb3a6725e92df4440450403b7b50de208e118365f118efcbb8677b"
            },
            "downloads": -1,
            "filename": "firebolt_cli-0.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6a4b35d4a76c1fe71b3095c9834990b6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 30419,
            "upload_time": "2024-02-05T15:34:12",
            "upload_time_iso_8601": "2024-02-05T15:34:12.857920Z",
            "url": "https://files.pythonhosted.org/packages/ee/d1/828576e10f176121f932cad92b17ff6a88d72da488b86b03067ac2b60932/firebolt_cli-0.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8af0a3af600d38175d1541a57bd2982a24e1d079b8544c03e6ae8a63edd45d14",
                "md5": "9800a05d9d47dd29c05ef31b5516d209",
                "sha256": "91a834bd1e5275fb3d8df853855654ea90c90b21676e5f201acd4caeeb4d3d46"
            },
            "downloads": -1,
            "filename": "firebolt_cli-0.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9800a05d9d47dd29c05ef31b5516d209",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 26246,
            "upload_time": "2024-02-05T15:34:14",
            "upload_time_iso_8601": "2024-02-05T15:34:14.244904Z",
            "url": "https://files.pythonhosted.org/packages/8a/f0/a3af600d38175d1541a57bd2982a24e1d079b8544c03e6ae8a63edd45d14/firebolt_cli-0.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-05 15:34:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "firebolt-db",
    "github_project": "firebolt-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "firebolt-cli"
}
        
Elapsed time: 0.19462s