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 #1761

Merged
merged 1 commit into from
Aug 13, 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 @@ -28,7 +28,7 @@ fly [flags]
* [litefs-cloud](/docs/flyctl/litefs-cloud/) - LiteFS Cloud management commands
* [logs](/docs/flyctl/logs/) - View app logs
* [machine](/docs/flyctl/machine/) - Manage Fly Machines.
* [mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases
* [mysql](/docs/flyctl/mysql/) - Provision and manage MySQL database clusters
* [orgs](/docs/flyctl/orgs/) - Commands for managing Fly organizations
* [ping](/docs/flyctl/ping/) - Test connectivity with ICMP ping messages
* [platform](/docs/flyctl/platform/) - Fly platform information
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ fly apps [command] [flags]

## Available Commands
* [create](/docs/flyctl/apps-create/) - Create a new application.
* [destroy](/docs/flyctl/apps-destroy/) - Permanently destroy one or more appa.
* [destroy](/docs/flyctl/apps-destroy/) - Permanently destroy one or more apps.
* [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.
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ fly auth [command] [flags]
* [login](/docs/flyctl/auth-login/) - Log in a user
* [logout](/docs/flyctl/auth-logout/) - Logs out the currently logged in user
* [signup](/docs/flyctl/auth-signup/) - Create a new fly account
* [token](/docs/flyctl/auth-token/) - Show the current auth token
* [token](/docs/flyctl/auth-token/) - Show the current auth token in use by flyctl.
* [whoami](/docs/flyctl/auth-whoami/) - Displays the users email address/service identity currently
authenticated and in use.

Expand Down
9 changes: 5 additions & 4 deletions flyctl/cmd/fly_auth_token.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Shows the authentication token that is currently in use.
This can be used as an authentication token with API services,
independent of flyctl.

Shows the authentication token that is currently in use by flyctl.
The auth token used by flyctl may expire quickly and shouldn't be used in places
where the token needs to keep working for a long time. For API authentication, you
can use the "fly tokens create" command instead, to create narrowly-scoped tokens with
a custom expiry.

## Usage
~~~
Expand Down
1 change: 1 addition & 0 deletions flyctl/cmd/fly_console.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ fly console [flags]
--vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag
--vm-memory string Memory (in megabytes) to attribute to the VM
--vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values
--volume strings Volume to mount, in the form of <volume_id_or_name>:/path/inside/machine[:<options>]
--wg Determines whether communication with remote builders are conducted over wireguard or plain internet(https) (default true)
~~~

Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ fly extensions [command] [flags]
* [enveloop](/docs/flyctl/extensions-enveloop/) - Provision and manage Enveloop projects
* [kafka](/docs/flyctl/extensions-kafka/) - Provision and manage Upstash Kafka clusters
* [kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters
* [mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases
* [mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL database clusters
* [sentry](/docs/flyctl/extensions-sentry/) - Setup a Sentry project for this app
* [storage](/docs/flyctl/extensions-storage/) - Provision and manage Tigris object storage buckets
* [supabase](/docs/flyctl/extensions-supabase/) - Provision and manage Supabase Postgres databases
Expand Down
3 changes: 2 additions & 1 deletion flyctl/cmd/fly_extensions_mysql.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Provision and manage MySQL databases
Provision and manage MySQL database clusters


## Usage
Expand All @@ -11,6 +11,7 @@ fly extensions mysql [command] [flags]
* [destroy](/docs/flyctl/extensions-mysql-destroy/) - Permanently destroy a MySQL database
* [list](/docs/flyctl/extensions-mysql-list/) - List your MySQL databases
* [status](/docs/flyctl/extensions-mysql-status/) - Show details about a MySQL database
* [update](/docs/flyctl/extensions-mysql-update/) - Update an existing MySQL database

## Options

Expand Down
6 changes: 5 additions & 1 deletion flyctl/cmd/fly_extensions_mysql_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ fly extensions mysql create [flags]
~~~
-a, --app string Application name
-c, --config string Path to application configuration file
--cpu int The number of CPUs assigned to each cluster member
--disk int Disk size (in GB) assigned to each cluster member
-h, --help help for create
--memory int Memory (in GB) assigned to each cluster member
-n, --name string The name of your database
-o, --org string The target Fly.io organization
-r, --region string The target region (see 'flyctl platform regions')
--size int The number of members in your cluster
-y, --yes Accept all confirmations
~~~

Expand All @@ -28,5 +32,5 @@ fly extensions mysql create [flags]

## See Also

* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases
* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL database clusters

2 changes: 1 addition & 1 deletion flyctl/cmd/fly_extensions_mysql_destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ fly extensions mysql destroy [name] [flags]

## See Also

* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases
* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL database clusters

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

## See Also

* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases
* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL database clusters

2 changes: 1 addition & 1 deletion flyctl/cmd/fly_extensions_mysql_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ fly extensions mysql status [name] [flags]

## See Also

* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases
* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL database clusters

34 changes: 34 additions & 0 deletions flyctl/cmd/fly_extensions_mysql_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Update an existing MySQL database


## Usage
~~~
fly extensions mysql update <database_name> [flags]
~~~

## Options

~~~
-a, --app string Application name
-c, --config string Path to application configuration file
--cpu int The number of CPUs assigned to each cluster member
--disk int Disk size (in GB) assigned to each cluster member
-h, --help help for update
--memory int Memory (in GB) assigned to each cluster member
-o, --org string The target Fly.io organization
--size int The number of members in your cluster
-y, --yes Accept all confirmations
~~~

## Global Options

~~~
-t, --access-token string Fly API Access Token
--debug Print additional logs and traces
--verbose Verbose output
~~~

## See Also

* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL database clusters

14 changes: 7 additions & 7 deletions flyctl/cmd/fly_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ fly logs [flags]
## Options

~~~
-a, --app string Application name
-c, --config string Path to application configuration file
-h, --help help for logs
-i, --instance string Filter by instance ID
-j, --json JSON output
-n, --no-tail Do not continually stream logs
-r, --region string The target region (see 'flyctl platform regions')
-a, --app string Application name
-c, --config string Path to application configuration file
-h, --help help for logs
-j, --json JSON output
--machine string Filter by machine ID
-n, --no-tail Do not continually stream logs
-r, --region string The target region (see 'flyctl platform regions')
~~~

## Global Options
Expand Down
3 changes: 2 additions & 1 deletion flyctl/cmd/fly_mysql.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Provision and manage MySQL databases
Provision and manage MySQL database clusters


## Usage
Expand All @@ -11,6 +11,7 @@ fly mysql [command] [flags]
* [destroy](/docs/flyctl/mysql-destroy/) - Permanently destroy a MySQL database
* [list](/docs/flyctl/mysql-list/) - List your MySQL databases
* [status](/docs/flyctl/mysql-status/) - Show details about a MySQL database
* [update](/docs/flyctl/mysql-update/) - Update an existing MySQL database

## Options

Expand Down
6 changes: 5 additions & 1 deletion flyctl/cmd/fly_mysql_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ fly mysql create [flags]
~~~
-a, --app string Application name
-c, --config string Path to application configuration file
--cpu int The number of CPUs assigned to each cluster member
--disk int Disk size (in GB) assigned to each cluster member
-h, --help help for create
--memory int Memory (in GB) assigned to each cluster member
-n, --name string The name of your database
-o, --org string The target Fly.io organization
-r, --region string The target region (see 'flyctl platform regions')
--size int The number of members in your cluster
-y, --yes Accept all confirmations
~~~

Expand All @@ -28,5 +32,5 @@ fly mysql create [flags]

## See Also

* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases
* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL database clusters

2 changes: 1 addition & 1 deletion flyctl/cmd/fly_mysql_destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ fly mysql destroy [name] [flags]

## See Also

* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases
* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL database clusters

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

## See Also

* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases
* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL database clusters

2 changes: 1 addition & 1 deletion flyctl/cmd/fly_mysql_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ fly mysql status [name] [flags]

## See Also

* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases
* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL database clusters

34 changes: 34 additions & 0 deletions flyctl/cmd/fly_mysql_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Update an existing MySQL database


## Usage
~~~
fly mysql update <database_name> [flags]
~~~

## Options

~~~
-a, --app string Application name
-c, --config string Path to application configuration file
--cpu int The number of CPUs assigned to each cluster member
--disk int Disk size (in GB) assigned to each cluster member
-h, --help help for update
--memory int Memory (in GB) assigned to each cluster member
-o, --org string The target Fly.io organization
--size int The number of members in your cluster
-y, --yes Accept all confirmations
~~~

## Global Options

~~~
-t, --access-token string Fly API Access Token
--debug Print additional logs and traces
--verbose Verbose output
~~~

## See Also

* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL database clusters

3 changes: 2 additions & 1 deletion flyctl/cmd/fly_tokens_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ fly tokens list [flags]
-a, --app string Application name
-c, --config string Path to application configuration file
-h, --help help for list
-s, --scope string either 'app' or 'org' (default "app")
-o, --org string The target Fly.io organization
-s, --scope string either 'app' or 'org'
~~~

## Global Options
Expand Down