GlassFlow CLI
Learn how to use GlassFlow CLI.
The GlassFlow Command Line Interface (CLI) is designed to streamline the interaction with the GlassFlow platform, enabling developers to create an account and efficiently manage and operate their data pipelines directly from the command line.
Getting Started
Resources
Installation
Before you can start using the GlassFlow CLI, you need to install it on your system. The CLI is available for macOS, Linux, and Windows.
Install using Homebrew
Install the GlassFlow CLI using the Homebrew:
This installs the GlassFlow command globally so you can run glassflow
commands from any directory.
Install from the release package
Install on Linux
Step 1: For Linux-based systems, run the following command to install the GlassFlow CLI:
To ensure that the GlassFlow CLI is accessible system-wide on a Linux system, move the GlassFlow executable to a directory that's included in your system's PATH.
Run the following command:
sudo mv ./glassflow /usr/local/bin/
This operation usessudo
typically requires superuser privileges and you need to enter sudo
passpord.
Step 2: Verify glassflow
installation:
Install on Windows
Step 1: Install the GlassFlow CLI on Windows OS by downloading the latest/desired release version and compatible package from the GitHub release page. For example, glassflow-cli-1.0.10-windows-386.zip
Step 2: Create a folder somewhere in your system, for example: C:\GlassFlow\CLI\bin
Step 3: Unzip the downloaded file and move it into the folder you created.
Step 4: Add the folder path to the Windows Path Environment System Variables.
Step 5: Verify glassflow
installation:
Update CLI version
Upgrading your GlassFlow CLI ensures you have the latest features, bug fixes, and performance improvements. Follow these guidelines to upgrade the GlassFlow CLI version.
For macOS (via Homebrew)
Upgrade the GlassFlow CLI package using Homebrew:
Confirm the upgrade by checking the version:
For Linux
Execute the installation script again to fetch and install the latest version:
Confirm the upgrade by checking the version:
For Windows
Navigate to the GlassFlow CLI GitHub release page and download the latest version compatible with Windows.
Update the Executable
If you previously created a folder for GlassFlow CLI (e.g.,
C:\GlassFlow\CLI\bin
), navigate to this folder.Delete the old
glassflow.exe
file.Unzip the newly downloaded file and move the new
glassflow.exe
into the same folder.
Ensure the folder path where glassflow.exe
resides is still in your Windows Path Environment System Variables. If you've not changed it since the initial installation, no action is needed here.
Confirm the upgrade by checking the version:
Sign Up
After installing the CLI, simply open your terminal and run the following command to create an account on GlassFlow:
Upon executing this command, you'll be prompted to choose your preferred method of signup—either using your Google account or via GitHub authentication.
Login
Run the following command to log in:
Authenticate with the GlassFlow platform using your email or GitHub account credentials. This step is crucial for accessing and managing your pipelines securely.
Getting Help
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:
You can also see available subcommands for a given command by running glassflow command --help
. For example:
Key Commands
Organizations
Organizations are top-level objects. All other objects like Space and Pipeline always belong under an organization. When a new user gets created, an associated organization is created automatically. All actions that the user performs are then part of that organization.
Actions
Space
Space allows you to organize and manage related pipelines and resources together. Space helps in structuring your pipelines and team collaborations more effectively. A user can have multiple spaces. All user permissions to pipelines are managed at the space level.
A default space main
is created when the user first signs up and if no other existing spaces. This way users can directly start creating a pipeline after signing up.
Actions
Pipeline
Pipeline facilitates a range of actions, from creating and deploying pipelines to monitoring their performance and managing their lifecycle. A pipeline always belongs to a space. You can create multiple pipelines within a single space.
If a user wants to invite someone to collaborate on a pipeline, they are added to the space to which the pipeline belongs and by default have access to all the pipelines within that space.
Actions
Pipeline names can include uppercase, lowercase letters, numbers, and special characters like underscore "_"
and dash "-"
.
Read more about the naming guideline.
Creating a pipeline without a transformation function leads to a pipeline with a default echo function. You can update the function for the pipeline later on by using the Update Function command.
Last updated