The GlassFlow Command Line Interface (CLI) simplifies the process of creating, managing, and monitoring your data pipelines on the GlassFlow platform. It's built for developers, data engineers, and IT professionals who prefer working within a command-line environment to automate tasks and streamline their workflow. The CLI directly interacts with the GlassFlow API for pipeline management.
- Pipeline Management: Create, update, delete, and list organizations, spaces, and data pipelines.
- Real-Time Data Processing: Send data to and consume data from your pipelines.
- Monitoring and Logs: Access real-time logs and monitor the performance of your pipelines.
- Secure Authentication: Manage your GlassFlow credentials securely.
The CLI is available for macOS, Linux, and Windows OS, and can be installed using standard package managers like Homebrew.
Install the GlassFlow CLI using the Homebrew:
brew tap glassflow/tap
brew install glassflow
This installs the GlassFlow command globally so you can run glassflow
commands from any directory.
For Linux based systems, we support installation by downloading the release version via GitHub:
/bin/bash -c "$(curl -fsSL https://github.com/raw/glassflow/cli/master/install.sh)"
To install the CLI on Windows OS, follow the guide in the documentation.
After installing the CLI, simply open your terminal and run the following command to create an account on GlassFlow:
glassflow signup
Upon executing this command, you'll be prompted to choose your preferred method of signup—either using your Google account or via GitHub authentication.
Open your terminal and type glassflow --help
to see a list of available commands and options. This command provides a quick reference to the capabilities of the CLI, including creating, removing, and managing your account, organization, space, and pipelines.
The general form of the CLI usage is:
glassflow --helpglassflow command [subcommand] [options]
$ glassflow --help
Usage: glassflow [OPTIONS] COMMAND [arg...]
GlassFlow - Python-based data streaming pipelines within minutes.
Options:
--version Show the version and exit
-v, --verbose Verbose output
Commands:
signup Create new account
login Log in to GlassFlow
profile Get profile data
logout Log out from GlassFlow
organization Manage organizations
space Manage spaces
pipeline Manage pipelines
version Show the version
You can also see available subcommands for a given command by running glassflow command --help
. For example:
$ glassflow pipeline --help
Usage: glassflow pipeline [OPTIONS] COMMAND [arg...]
Manage pipelines
Options:
Commands:
list Get pipelines
create Create pipeline
get Get pipeline
delete Delete pipeline
update-function Update function
logs Get function logs
tokens Get list of access tokens
token-generate Generate new access token
token-rename Rename access token
token-revoke Revoke access token
Visit the GlassFlow examples repository to explore how to build new pipelines using CLI.
For more detailed information on how to use the GlassFlow CLI, please refer to the GlassFlow Documentation. The documentation provides comprehensive guides, tutorials, and examples to help you get started with GlassFlow CLI.