Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README for clarity, consistency, and formatting #3712

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 29 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# flyctl

flyctl is a command-line interface for fly.io
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`.
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
### 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
### Install Script

Download `flyctl` and install into a local bin directory.
Download `flyctl` and install it into a local bin directory.

#### MacOS, Linux, WSL
#### macOS, Linux, WSL

Installing the latest version:

Expand All @@ -46,61 +46,59 @@ curl -L https://fly.io/install.sh | sh -s 0.0.200

#### Windows

Run the Powershell install script:
Run the PowerShell install script:

```
```powershell
iwr https://fly.io/install.ps1 -useb | iex
```


## Downloading from GitHub
### 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
1. Sign into your Fly account:

```bash
fly auth login
```
```bash
fly auth login
```

2. List your apps
2. List your apps:

```bash
fly apps list
```
```bash
fly apps list
```

2. View app status
3. View app status:

```bash
fly status -a {app-name}
```
```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.
`flyctl` will operate against the `banana` app unless overridden by the `-a` flag or another 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`.

`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.
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
## 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.
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

## Contributing guide
See [CONTRIBUTING.md](./CONTRIBUTING.md)