https://github.com/flyteorg/flytectl

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

brew cli cobra-viper command-line-interface cross-platform flyte flyte-cli gitops golang hacktoberfest workflows

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/flyteorg/flytectl
• Owner: flyteorg
• License: apache-2.0
• Created: 2020-01-03T17:07:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-11T21:07:54.000Z (about 1 year ago)
• Last Synced: 2024-04-12T02:21:46.112Z (about 1 year ago)
• Topics: brew, cli, cobra-viper, command-line-interface, cross-platform, flyte, flyte-cli, gitops, golang, hacktoberfest, workflows
• Language: Go
• Homepage: https://flyte.org
• Size: 2.7 MB
• Stars: 45
• Watchers: 200
• Forks: 80
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
| 🗑  As of May-24 we moved the development of this component to [monorepo](https://github.com/flyteorg/flyte). 🗑  |

| - |

    
 

        

    

    


        FlyteCTL

    

    


       Flyte's official command-line interface

    

    


        Documentation

         · 

        Contribution Guide

    


[![Docs](https://readthedocs.org/projects/flytectl/badge/?version=latest&style=plastic)](https://flytectl.rtfd.io)

[![Current Release](https://img.shields.io/github/release/flyteorg/flytectl.svg)](https://github.com/flyteorg/flytectl/releases/latest)

![Master](https://github.com/flyteorg/flytectl/workflows/Master/badge.svg)

[![GoDoc](https://godoc.org/github.com/flyteorg/flytectl?status.svg)](https://pkg.go.dev/mod/github.com/flyteorg/flytectl)

[![License](https://img.shields.io/badge/LICENSE-Apache2.0-ff69b4.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)

[![CodeCoverage](https://img.shields.io/codecov/c/github/flyteorg/flytectl.svg)](https://codecov.io/gh/flyteorg/flytectl)

[![Go Report Card](https://goreportcard.com/badge/github.com/flyteorg/flytectl)](https://goreportcard.com/report/github.com/flyteorg/flytectl)

![Commit activity](https://img.shields.io/github/commit-activity/w/lyft/flytectl.svg?style=plastic)

![Commit since last release](https://img.shields.io/github/commits-since/lyft/flytectl/latest.svg?style=plastic)

[![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org)

Flytectl was designed as a portable and lightweight command-line interface to work with Flyte. It is written in Golang and accesses [FlyteAdmin](https://github.com/flyteorg/flyteadmin/), the control plane for Flyte.

## 🚀 Quick Start

1. Install Flytectl with bash or shell script.

    * Bash

        ```bash

        $ brew install flyteorg/homebrew-tap/flytectl

        ```

    * Shell script

        ```bash

        $ 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.

    ```bash

    $ flytectl sandbox start 

    ```

4. Register examples.

    ```bash

    # Register core workflows 

    $ flytectl register examples -d development -p flytesnacks

    ```

    
 

        📖 How to Contribute to Flytectl

    


You can find the detailed contribution guide [here](docs/source/contribute.rst).

    
 

        🐞 File an Issue

    


Refer to the [issues](https://docs.flyte.org/en/latest/community/contribute.html#file-an-issue) section in the contribution

guide if you'd like to file an issue.