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

[flybot] Fly CLI docs update #1538

Merged
merged 1 commit into from
May 23, 2024
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion flyctl/cmd/fly.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ fly [flags]

## Available Commands
* [agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections
* [apps](/docs/flyctl/apps/) - Manage apps
* [apps](/docs/flyctl/apps/) - Manage apps.
* [auth](/docs/flyctl/auth/) - Manage authentication
* [certs](/docs/flyctl/certs/) - Manage certificates
* [checks](/docs/flyctl/checks/) - Manage health checks
Expand Down
15 changes: 6 additions & 9 deletions flyctl/cmd/fly_apps.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
The APPS commands focus on managing your Fly applications.
Start with the CREATE command to register your application.
The LIST command will list all currently registered applications.

Manage your Fly applications.

## Usage
~~~
fly apps [command] [flags]
~~~

## Available Commands
* [create](/docs/flyctl/apps-create/) - Create a new application
* [destroy](/docs/flyctl/apps-destroy/) - Permanently destroys an app
* [create](/docs/flyctl/apps-create/) - Create a new application.
* [destroy](/docs/flyctl/apps-destroy/) - Permanently destroy an app.
* [errors](/docs/flyctl/apps-errors/) - View application errors on Sentry.io
* [list](/docs/flyctl/apps-list/) - List applications
* [move](/docs/flyctl/apps-move/) - Move an app to another organization
* [list](/docs/flyctl/apps-list/) - List applications.
* [move](/docs/flyctl/apps-move/) - Move an app to another organization.
* [open](/docs/flyctl/apps-open/) - Open browser to current deployed application
* [releases](/docs/flyctl/apps-releases/) - List app releases
* [restart](/docs/flyctl/apps-restart/) - Restart an application
* [restart](/docs/flyctl/apps-restart/) - Restart an application.

## Options

Expand Down
10 changes: 5 additions & 5 deletions flyctl/cmd/fly_apps_create.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
The APPS CREATE command will register a new application
with the Fly platform. It will not generate a configuration file, but one
may be fetched with 'fly config save -a <app_name>'
Create a new application on the Fly platform.
This command won't generate a fly.toml configuration file, but you can
fetch one with 'fly config save -a <app_name>'.

## Usage
~~~
fly apps create [APPNAME] [flags]
fly apps create <app name> [flags]
~~~

## Options
Expand All @@ -28,5 +28,5 @@ fly apps create [APPNAME] [flags]

## See Also

* [fly apps](/docs/flyctl/apps/) - Manage apps
* [fly apps](/docs/flyctl/apps/) - Manage apps.

8 changes: 3 additions & 5 deletions flyctl/cmd/fly_apps_destroy.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
The APPS DESTROY command will remove an application
from the Fly platform.

Delete an application from the Fly platform.

## Usage
~~~
fly apps destroy <APPNAME> [flags]
fly apps destroy <app name> [flags]
~~~

## Options
Expand All @@ -24,5 +22,5 @@ fly apps destroy <APPNAME> [flags]

## See Also

* [fly apps](/docs/flyctl/apps/) - Manage apps
* [fly apps](/docs/flyctl/apps/) - Manage apps.

2 changes: 1 addition & 1 deletion flyctl/cmd/fly_apps_errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ fly apps errors [flags]

## See Also

* [fly apps](/docs/flyctl/apps/) - Manage apps
* [fly apps](/docs/flyctl/apps/) - Manage apps.

10 changes: 5 additions & 5 deletions flyctl/cmd/fly_apps_list.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The APPS LIST command will show the applications currently
registered and available to this user. The list will include applications
from all the organizations the user is a member of. Each application will
be shown with its name, owner and when it was last deployed.
List the applications currently
available to this user. The list includes applications
from all the organizations the user is a member of. The list shows
the name, owner (org), status, and date/time of latest deploy for each app.


## Usage
Expand All @@ -27,5 +27,5 @@ fly apps list [flags]

## See Also

* [fly apps](/docs/flyctl/apps/) - Manage apps
* [fly apps](/docs/flyctl/apps/) - Manage apps.

6 changes: 3 additions & 3 deletions flyctl/cmd/fly_apps_move.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
The APPS MOVE command will move an application to another
Move an application to another
organization the current user belongs to.


## Usage
~~~
fly apps move <APPNAME> [flags]
fly apps move <app name> [flags]
~~~

## Options
Expand All @@ -26,5 +26,5 @@ fly apps move <APPNAME> [flags]

## See Also

* [fly apps](/docs/flyctl/apps/) - Manage apps
* [fly apps](/docs/flyctl/apps/) - Manage apps.

2 changes: 1 addition & 1 deletion flyctl/cmd/fly_apps_open.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ fly apps open [RELATIVE_URI] [flags]

## See Also

* [fly apps](/docs/flyctl/apps/) - Manage apps
* [fly apps](/docs/flyctl/apps/) - Manage apps.

2 changes: 1 addition & 1 deletion flyctl/cmd/fly_apps_releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ fly apps releases [flags]

## See Also

* [fly apps](/docs/flyctl/apps/) - Manage apps
* [fly apps](/docs/flyctl/apps/) - Manage apps.

6 changes: 3 additions & 3 deletions flyctl/cmd/fly_apps_restart.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
The APPS RESTART command will perform a rolling restart against all running VMs
Restart an application. Perform a rolling restart against all running Machines.

## Usage
~~~
fly apps restart [APPNAME] [flags]
fly apps restart <app name> [flags]
~~~

## Options
Expand All @@ -23,5 +23,5 @@ fly apps restart [APPNAME] [flags]

## See Also

* [fly apps](/docs/flyctl/apps/) - Manage apps
* [fly apps](/docs/flyctl/apps/) - Manage apps.

2 changes: 2 additions & 0 deletions flyctl/cmd/fly_config_save.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ fly config save [flags]
-a, --app string Application name
-c, --config string Path to application configuration file
-h, --help help for save
--json Output the configuration in JSON format
--yaml Output the configuration in YAML format
-y, --yes Accept all confirmations
~~~

Expand Down
6 changes: 4 additions & 2 deletions flyctl/cmd/fly_config_show.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Show an application's configuration. The configuration is presented
Show an application's configuration. The configuration is presented by default
in JSON format. The configuration data is retrieved from the Fly service.

## Usage
Expand All @@ -12,7 +12,9 @@ fly config show [flags]
-a, --app string Application name
-c, --config string Path to application configuration file
-h, --help help for show
--local Parse and show local fly.toml as JSON
--local Parse and show local fly.toml file instead of fetching from the Fly service
--toml Show configuration in TOML format
--yaml Show configuration in YAML format
~~~

## Global Options
Expand Down
2 changes: 2 additions & 0 deletions flyctl/cmd/fly_launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ fly launch [flags]
-i, --image string The Docker image to deploy
--image-label string Image label to use when tagging and pushing to the fly registry. Defaults to "deployment-{timestamp}".
--internal-port int Set internal_port for all services in the generated fly.toml (default -1)
--json Generate configuration in JSON format
--label stringArray Add custom metadata to an image via docker labels
--lease-timeout string Time duration to lease individual machines while running deployment. All machines are leased at the beginning and released at the end.The lease is refreshed periodically for this same time, which is why it is short.flyctl releases leases in most cases. (default "13s")
--local-only Perform builds locally using the local docker daemon. The default is --remote-only.
Expand Down Expand Up @@ -79,6 +80,7 @@ fly launch [flags]
--volume-initial-size int The initial size in GB for volumes created on first deploy
--wait-timeout string Time duration to wait for individual machines to transition states and become healthy. (default "5m0s")
--wg Determines whether communication with remote builders are conducted over wireguard or plain internet(https) (default true)
--yaml Generate configuration in YAML format
-y, --yes Accept all confirmations
~~~

Expand Down
3 changes: 1 addition & 2 deletions flyctl/cmd/fly_machine_clone.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Clone a Fly Machine The new Machine will be a copy of the specified Machine.
If the original Machine has a volume, then a new empty volume will be created and attached to the new Machine.
Clone a Fly Machine. The new Machine will be a copy of the specified Machine. If the original Machine has a volume, then a new empty volume will be created and attached to the new Machine.

## Usage
~~~
Expand Down
4 changes: 2 additions & 2 deletions flyctl/cmd/fly_volumes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Manage Fly Volumes.
Manage Fly Volumes. Volumes are persistent storage for Fly Machines. Learn how how volumes work: https://fly.io/docs/reference/volumes/.

## Usage
~~~
Expand All @@ -12,7 +12,7 @@ fly volumes [command] [flags]
* [fork](/docs/flyctl/volumes-fork/) - Fork the specified volume.
* [list](/docs/flyctl/volumes-list/) - List the volumes associated with an app.
* [show](/docs/flyctl/volumes-show/) - Show the details of the specified volume.
* [snapshots](/docs/flyctl/volumes-snapshots/) - Manage volume snapshots
* [snapshots](/docs/flyctl/volumes-snapshots/) - Manage volume snapshots.
* [update](/docs/flyctl/volumes-update/) - Update a volume for an app.

## Options
Expand Down
8 changes: 4 additions & 4 deletions flyctl/cmd/fly_volumes_create.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Volumes are persistent storage for Fly Machines. Learn how to add a volume to your app: https://fly.io/docs/apps/volume-storage/
Create a new volume for an app. Volumes are persistent storage for Fly Machines. Learn how to add a volume to your app: https://fly.io/docs/apps/volume-storage/.

## Usage
~~~
fly volumes create <volumename> [flags]
fly volumes create <volume name> [flags]
~~~

## Options
Expand All @@ -16,10 +16,10 @@ fly volumes create <volumename> [flags]
-j, --json JSON output
--no-encryption Do not encrypt the volume contents. Volume contents are encrypted by default.
-r, --region string The target region (see 'flyctl platform regions')
--require-unique-zone Place the volume in a separate hardware zone from existing volumes. This is the default. (default true)
--require-unique-zone Place the volume in a separate hardware zone from existing volumes to help ensure availability (default true)
-s, --size int The size of volume in gigabytes (default 1)
--snapshot-id string Create the volume from the specified snapshot
--snapshot-retention int Snapshot retention in days (min 5) (default 5)
--snapshot-retention int Snapshot retention in days (default 5)
--vm-cpu-kind string The kind of CPU to use ('shared' or 'performance')
--vm-cpus int Number of CPUs
--vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10)
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_volumes_destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Destroy one or more volumes. When you destroy a volume, you permanently delete a

## Usage
~~~
fly volumes destroy [flags] ID ID ...
fly volumes destroy <volume id> ... [flags]
~~~

## Options
Expand Down
4 changes: 2 additions & 2 deletions flyctl/cmd/fly_volumes_extend.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Extend a volume to the specified size. Most Machines don't require a restart. Some older Machines get a message to manually restart the Machine to increase the size of the file system.
Extend a volume to the specified size. Most Machines don't require a restart after extending a volume. Some older Machines get a message to manually restart the Machine to increase the size of the file system.

## Usage
~~~
fly volumes extend [id] [flags]
fly volumes extend <volume id> [flags]
~~~

## Options
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_volumes_fork.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Fork the specified volume. Volume forking creates an independent copy of a stora

## Usage
~~~
fly volumes fork [id] [flags]
fly volumes fork <volume id> [flags]
~~~

## Options
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_volumes_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Show the details of the specified volume.

## Usage
~~~
fly volumes show [id] [flags]
fly volumes show <volume id> [flags]
~~~

## Options
Expand Down
7 changes: 3 additions & 4 deletions flyctl/cmd/fly_volumes_snapshots.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
"Commands for managing volume snapshots"

Manage volume snapshots. A snapshot is a point-in-time copy of a volume. Snapshots can be used to create new volumes or restore a volume to a previous state.

## Usage
~~~
fly volumes snapshots [command] [flags]
~~~

## Available Commands
* [create](/docs/flyctl/volumes-snapshots-create/) - Snapshot a volume
* [list](/docs/flyctl/volumes-snapshots-list/) - List snapshots
* [create](/docs/flyctl/volumes-snapshots-create/) - Create a volume snapshot.
* [list](/docs/flyctl/volumes-snapshots-list/) - List snapshots.

## Options

Expand Down
4 changes: 2 additions & 2 deletions flyctl/cmd/fly_volumes_snapshots_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Snapshot a volume

## Usage
~~~
fly volumes snapshots create <volume-id> [flags]
fly volumes snapshots create <volume id> [flags]
~~~

## Options
Expand All @@ -23,5 +23,5 @@ fly volumes snapshots create <volume-id> [flags]

## See Also

* [fly volumes snapshots](/docs/flyctl/volumes-snapshots/) - Manage volume snapshots
* [fly volumes snapshots](/docs/flyctl/volumes-snapshots/) - Manage volume snapshots.

6 changes: 3 additions & 3 deletions flyctl/cmd/fly_volumes_snapshots_list.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
List snapshots associated with the specified volume
List snapshots associated with the specified volume.

## Usage
~~~
fly volumes snapshots list <volume-id> [flags]
fly volumes snapshots list <volume id> [flags]
~~~

## Options
Expand All @@ -22,5 +22,5 @@ fly volumes snapshots list <volume-id> [flags]

## See Also

* [fly volumes snapshots](/docs/flyctl/volumes-snapshots/) - Manage volume snapshots
* [fly volumes snapshots](/docs/flyctl/volumes-snapshots/) - Manage volume snapshots.

9 changes: 4 additions & 5 deletions flyctl/cmd/fly_volumes_update.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
Update a volume for an app. Volumes are persistent storage for
Fly Machines. Learn how to add a volume to
your app: https://fly.io/docs/apps/volume-storage/
Fly Machines.

## Usage
~~~
fly volumes update <volumename> [flags]
fly volumes update <volume id> [flags]
~~~

## Options
Expand All @@ -14,8 +13,8 @@ fly volumes update <volumename> [flags]
-c, --config string Path to application configuration file
-h, --help help for update
-j, --json JSON output
--scheduled-snapshots Disable/Enable scheduled snapshots
--snapshot-retention int Snapshot retention in days (min 5)
--scheduled-snapshots Activate/deactivate scheduled automatic snapshots
--snapshot-retention int Snapshot retention in days
~~~

## Global Options
Expand Down
Loading