https://github.com/glassflow/cli
GlassFlow CLI to create and manage data pipelines
https://github.com/glassflow/cli
cli data-pipelines data-transformation real-time stream-processing
Last synced: about 2 months ago
JSON representation
GlassFlow CLI to create and manage data pipelines
- Host: GitHub
- URL: https://github.com/glassflow/cli
- Owner: glassflow
- Created: 2024-02-20T16:21:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T15:47:28.000Z (over 1 year ago)
- Last Synced: 2024-09-05T22:00:39.150Z (over 1 year ago)
- Topics: cli, data-pipelines, data-transformation, real-time, stream-processing
- Language: Shell
- Homepage: https://docs.glassflow.dev
- Size: 12.7 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GlassFlow CLI
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](https://api.glassflow.xyz/v1/docs) for pipeline management.
## Features
- **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.
## Installation
The CLI is available for **macOS, Linux, and Windows** OS, and can be installed using standard package managers like [Homebrew](https://brew.sh/).
### Install using Homebrew
Install the GlassFlow CLI using the Homebrew:
```bash
brew tap glassflow/tap
brew install glassflow
```
This installs the GlassFlow command globally so you can run `glassflow`commands from any directory.
### Install from the release package
For **Linux** based systems, we support installation by downloading the release version via GitHub:
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/glassflow/cli/master/install.sh)"
```
To install the CLI on **Windows** OS, follow the [guide in the documentation](https://docs.glassflow.dev/get-started/glassflow-cli#for-windows).
## Sign Up
After installing the CLI, simply open your terminal and run the following command to create an account on GlassFlow:
```bash
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.
## 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:
```bash
glassflow --helpglassflow command [subcommand] [options]
```
```bash
$ 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:
```bash
$ 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
```
## Examples
Visit the [GlassFlow examples](https://github.com/glassflow/glassflow-examples) repository to explore how to build new pipelines using CLI.
## User Guides
For more detailed information on how to use the GlassFlow CLI, please refer to the [GlassFlow Documentation](https://learn.glassflow.dev/). The documentation provides comprehensive guides, tutorials, and examples to help you get started with GlassFlow CLI.