Skip to content

Beacon Data Lake CLI Tool

WARNING

The Beacon Data Lake CLI Tool is currently under development and may undergo significant changes. Please refer to the latest documentation for updates.

The Beacon Data Lake CLI Tool is a command-line interface designed to facilitate the management and interaction with the Beacon Data Lake. It provides users and admins with a set of commands to perform various operations such as dataset ingestion, querying, and schema management.

The CLI tool is built using Python and on top of the Beacon Python SDK, ensuring seamless integration with the Beacon Data Lake ecosystem.

The source code for the CLI tool can be found on GitHub: beacon-datalake-cli

The python SDK can be found here: beacon-api

Installation

To install the Beacon Data Lake CLI Tool, follow these steps:

  1. Ensure you have python 3.10 or higher installed on your system.

  2. Install the CLI tool using pip:

    bash
    pip install beacon-datalake-cli
  3. Verify the installation by running the following command in your terminal (this can take a few seconds to start):

    bash
    beacon-datalake-cli

Usage

Once installed, you can use the Beacon Data Lake CLI Tool by running the beacon-datalake-cli which will start the interactive command-line interface.

Beacon Data Lake CLI Tool