Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.
/ flytectl Public archive

A cross platform CLI for Flyte. Written in Golang. Offers an intuitive interface to Flyte https://docs.flyte.org/projects/flytectl/en/latest/

License

Notifications You must be signed in to change notification settings

flyteorg/flytectl

Repository files navigation

🗑 As of May-24 we moved the development of this component to monorepo. 🗑

Flyte Logo

FlyteCTL

Flyte's official command-line interface

Docs Current Release Master GoDoc License CodeCoverage Go Report Card Commit activity Commit since last release Slack

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.