Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/superfly/flyctl
Command line tools for fly.io services
https://github.com/superfly/flyctl
flyio-tools
Last synced: 4 days ago
JSON representation
Command line tools for fly.io services
- Host: GitHub
- URL: https://github.com/superfly/flyctl
- Owner: superfly
- License: apache-2.0
- Created: 2019-07-26T18:03:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-09T17:52:22.000Z (4 days ago)
- Last Synced: 2024-12-09T18:41:09.976Z (4 days ago)
- Topics: flyio-tools
- Language: Go
- Homepage: https://fly.io
- Size: 17.2 MB
- Stars: 1,445
- Watchers: 26
- Forks: 245
- Open Issues: 321
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# flyctl
flyctl is a command-line interface for fly.io
Note: Most installations of `flyctl` also alias `flyctl` to `fly` as a command name and this will become the default name in the future.
During the transition, note that where you see `flyctl` as a command it can be replaced with `fly`.
## Installation
## Using a Package Manager
#### [Homebrew](https://brew.sh) (macOS, Linux, WSL)
```bash
brew install flyctl
```
To upgrade to the latest version:
```bash
brew upgrade flyctl
```
## Install Script
Download `flyctl` and install into a local bin directory.
#### MacOS, Linux, WSL
Installing the latest version:
```bash
curl -L https://fly.io/install.sh | sh
```
Installing the latest pre-release version:
```bash
curl -L https://fly.io/install.sh | sh -s pre
```
Installing a specific version:
```bash
curl -L https://fly.io/install.sh | sh -s 0.0.200
```
#### Windows
Run the Powershell install script:
```
iwr https://fly.io/install.ps1 -useb | iex
```
## Downloading from GitHub
Download the appropriate version from the [Releases](https://github.com/superfly/flyctl/releases) page of the `flyctl` GitHub repository.
## Getting Started
1. Sign into your fly account
```bash
fly auth login
```
2. List your apps
```bash
fly apps list
```
3. View app status
```bash
fly status -a {app-name}
```
## App Settings
`flyctl` will attempt to use the app name from a `fly.toml` file in the current directory. For example, if the current directory contains this file:
```bash
$ cat fly.toml
app: banana
```
`flyctl` will operate against the `banana` app unless overridden by the -a flag or other app name setting in the command line.
## Releases
`flyctl` is automatically released at 3 PM Eastern Standard Time Monday - Thursday. If needed, you can bump a release by running `./scripts/bump_version.sh`.
## Building on Windows
There is a simple Powershell script, `winbuild.ps1`, which will run the code generation for the help files, format them, and run a full build, leaving a new binary in the bin directory.
## Running from branches on your local machine
Run `scripts/build-dfly` to build a Docker image from the current branch. Then, use `scripts/dfly` to run it. This assumes you are already
authenticated to Fly in your local environment.
## Contributing guide
See [CONTRIBUTING.md](./CONTRIBUTING.md)