README.md

FlyteCTL

Flyte's official command-line interface

Documentation · Contribution Guide

Flytectl was designed as a portable and lightweight command-line interface to work with Flyte. It is written in Golang and accesses FlyteAdmin, the control plane for Flyte.

🚀 Quick Start

1. Install Flytectl with bash or shell script.

   • Bash

     $ brew install flyteorg/homebrew-tap/flytectl

   • Shell script

     $ curl -sL https://ctl.flyte.org/install | bash

2. (Optional) flytectl upgrade provides a general interface to upgrading Flytectl; run the command in the output.

3. Start Sandbox using Flytectl.

   $ flytectl sandbox start 

4. Register examples.

   # Register core workflows 
   $ flytectl register examples -d development -p flytesnacks

📖 How to Contribute to Flytectl

You can find the detailed contribution guide here.

🐞 File an Issue

Refer to the issues section in the contribution guide if you'd like to file an issue.