Skip to content
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
93 changes: 44 additions & 49 deletions flyctl/cmd/fly_help.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: fly help
title: fly
source_url: https://fly.io/docs/flyctl/help/
---

Expand All @@ -9,52 +9,50 @@ This is flyctl, the Fly.io command line interface.
```
fly [flags]
```

## Available Commands
* [agent](/flyctl/cmd/fly_agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections
* [apps](/flyctl/cmd/fly_apps/) - Manage apps.
* [auth](/flyctl/cmd/fly_auth/) - Manage authentication
* [certs](/flyctl/cmd/fly_certs/) - Manage certificates
* [checks](/flyctl/cmd/fly_checks/) - Manage health checks
* [config](/flyctl/cmd/fly_config/) - Manage an app's configuration
* [console](/flyctl/cmd/fly_console/) - Run a console in a new or existing machine
* [consul](/flyctl/cmd/fly_consul/) - Enable and manage Consul clusters
* [dashboard](/flyctl/cmd/fly_dashboard/) - Open web browser on Fly Web UI for this app
* [deploy](/flyctl/cmd/fly_deploy/) - Deploy Fly applications
* [dig](/flyctl/cmd/fly_dig/) - Make DNS requests against Fly.io's internal DNS server
* [docs](/flyctl/index) - View Fly documentation
* [doctor](/flyctl/cmd/fly_doctor/) - The DOCTOR command allows you to debug your Fly environment
* [extensions](/flyctl/cmd/fly_extensions/) - Extensions are additional functionality that can be added to your Fly apps
* [image](/flyctl/cmd/fly_image/) - Manage app image
* [incidents](/flyctl/cmd/fly_incidents/) - Show incidents
* [ips](/flyctl/cmd/fly_ips/) - Manage IP addresses for apps
* [jobs](/flyctl/cmd/fly_jobs/) - Show jobs at Fly.io
* [launch](/flyctl/cmd/fly_launch/) - Create and configure a new app from source code or a Docker image
* [litefs-cloud](/flyctl/cmd/fly_litefs-cloud/) - LiteFS Cloud management commands
* [logs](/flyctl/cmd/fly_logs/) - View app logs
* [machine](/flyctl/cmd/fly_machine/) - Manage Fly Machines.
* [mcp](/flyctl/cmd/fly_mcp/) - flyctl Model Context Protocol.
* [mpg](/flyctl/cmd/fly_mpg/) - Manage Managed Postgres clusters.
* [orgs](/flyctl/cmd/fly_orgs/) - Commands for managing Fly organizations
* [ping](/flyctl/cmd/fly_ping/) - Test connectivity with ICMP ping messages
* [platform](/flyctl/cmd/fly_platform/) - Fly platform information
* [postgres](/flyctl/cmd/fly_postgres/) - Unmanaged Postgres cluster commands
* [proxy](/flyctl/cmd/fly_proxy/) - Proxies connections to a Fly Machine.
* [redis](/flyctl/cmd/fly_redis/) - Launch and manage Redis databases managed by Upstash.com
* [releases](/flyctl/cmd/fly_releases/) - List app releases
* [scale](/flyctl/cmd/fly_scale/) - Scale app resources
* [secrets](/flyctl/cmd/fly_secrets/) - Manage application secrets with the set and unset commands.
* [services](/flyctl/cmd/fly_services/) - Show the application's services
* [settings](/flyctl/cmd/fly_settings/) - Manage flyctl settings
* [sftp](/flyctl/cmd/fly_sftp/) - Get or put files from a remote VM.
* [ssh](/flyctl/cmd/fly_ssh/) - Use SSH to log into or run commands on Machines
* [status](/flyctl/cmd/fly_status/) - Show app status
* [storage](/flyctl/cmd/fly_storage/) - Provision and manage Tigris object storage buckets
* [synthetics](/flyctl/cmd/fly_synthetics/) - Synthetic monitoring
* [tokens](/flyctl/cmd/fly_tokens/) - Manage Fly.io API tokens
* [version](/flyctl/cmd/fly_version/) - Show version information for the flyctl command
* [volumes](/flyctl/cmd/fly_volumes/) - Manage Fly Volumes.
* [wireguard](/flyctl/cmd/fly_wireguard/) - Commands that manage WireGuard peer connections
* [agent](/flyctl/cmd/fly_agent) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections
* [apps](/flyctl/cmd/fly_apps) - Manage apps.
* [auth](/flyctl/cmd/fly_auth) - Manage authentication
* [certs](/flyctl/cmd/fly_certs) - Manage certificates
* [checks](/flyctl/cmd/fly_checks) - Manage health checks
* [config](/flyctl/cmd/fly_config) - Manage an app's configuration
* [console](/flyctl/cmd/fly_console) - Run a console in a new or existing machine
* [consul](/flyctl/cmd/fly_consul) - Enable and manage Consul clusters
* [dashboard](/flyctl/cmd/fly_dashboard) - Open web browser on Fly Web UI for this app
* [deploy](/flyctl/cmd/fly_deploy) - Deploy Fly applications
* [dig](/flyctl/cmd/fly_dig) - Make DNS requests against Fly.io's internal DNS server
* [docs](/flyctl/cmd/fly_docs) - View Fly documentation
* [doctor](/flyctl/cmd/fly_doctor) - The DOCTOR command allows you to debug your Fly environment
* [extensions](/flyctl/cmd/fly_extensions) - Extensions are additional functionality that can be added to your Fly apps
* [image](/flyctl/cmd/fly_image) - Manage app image
* [incidents](/flyctl/cmd/fly_incidents) - Show incidents
* [ips](/flyctl/cmd/fly_ips) - Manage IP addresses for apps
* [jobs](/flyctl/cmd/fly_jobs) - Show jobs at Fly.io
* [launch](/flyctl/cmd/fly_launch) - Create and configure a new app from source code or a Docker image
* [logs](/flyctl/cmd/fly_logs) - View app logs
* [machine](/flyctl/cmd/fly_machine) - Manage Fly Machines.
* [mcp](/flyctl/cmd/fly_mcp) - flyctl Model Context Protocol.
* [mpg](/flyctl/cmd/fly_mpg) - Manage Managed Postgres clusters.
* [orgs](/flyctl/cmd/fly_orgs) - Commands for managing Fly organizations
* [ping](/flyctl/cmd/fly_ping) - Test connectivity with ICMP ping messages
* [platform](/flyctl/cmd/fly_platform) - Fly platform information
* [postgres](/flyctl/cmd/fly_postgres) - Unmanaged Postgres cluster commands
* [proxy](/flyctl/cmd/fly_proxy) - Proxies connections to a Fly Machine.
* [redis](/flyctl/cmd/fly_redis) - Launch and manage Redis databases managed by Upstash.com
* [releases](/flyctl/cmd/fly_releases) - List app releases
* [scale](/flyctl/cmd/fly_scale) - Scale app resources
* [secrets](/flyctl/cmd/fly_secrets) - Manage application secrets with the set and unset commands.
* [services](/flyctl/cmd/fly_services) - Show the application's services
* [settings](/flyctl/cmd/fly_settings) - Manage flyctl settings
* [sftp](/flyctl/cmd/fly_sftp) - Get or put files from a remote VM.
* [ssh](/flyctl/cmd/fly_ssh) - Use SSH to log into or run commands on Machines
* [status](/flyctl/cmd/fly_status) - Show app status
* [storage](/flyctl/cmd/fly_storage) - Provision and manage Tigris object storage buckets
* [synthetics](/flyctl/cmd/fly_synthetics) - Synthetic monitoring
* [tokens](/flyctl/cmd/fly_tokens) - Manage Fly.io API tokens
* [version](/flyctl/cmd/fly_version) - Show version information for the flyctl command
* [volumes](/flyctl/cmd/fly_volumes) - Manage Fly Volumes.
* [wireguard](/flyctl/cmd/fly_wireguard) - Commands that manage WireGuard peer connections

## Options

Expand All @@ -64,7 +62,4 @@ fly [flags]
-h, --help help for fly
--verbose Verbose output
```

## See Also


2 changes: 1 addition & 1 deletion flyctl/cmd/fly_machine_create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ fly machine create <image> [command] [flags]
--host-dedication-id string The dedication id of the reserved hosts for your organization (if any)
--id string Machine ID, if previously known
--kernel-arg stringArray A list of kernel arguments to provide to the init. Can be specified multiple times.
--machine-config string Read machine config from json file or string
--machine-config string Read Machine config from a JSON file or string (use --config for app configuration)
-m, --metadata stringArray Metadata in the form of NAME=VALUE pairs. Can be specified multiple times.
-n, --name string Machine name. Will be generated if omitted.
--org string The organization that will own the app
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_machine_run.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ fly machine run <image> [command] [flags]
--host-dedication-id string The dedication id of the reserved hosts for your organization (if any)
--id string Machine ID, if previously known
--kernel-arg stringArray A list of kernel arguments to provide to the init. Can be specified multiple times.
--machine-config string Read machine config from json file or string
--machine-config string Read Machine config from a JSON file or string (use --config for app configuration)
-m, --metadata stringArray Metadata in the form of NAME=VALUE pairs. Can be specified multiple times.
-n, --name string Machine name. Will be generated if omitted.
--org string The organization that will own the app
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_machine_update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ fly machine update [machine_id] [flags]
--host-dedication-id string The dedication id of the reserved hosts for your organization (if any)
-i, --image string The Docker image to deploy
--kernel-arg stringArray A list of kernel arguments to provide to the init. Can be specified multiple times.
--machine-config string Read machine config from json file or string
--machine-config string Read Machine config from a JSON file or string (use --config for app configuration)
-m, --metadata stringArray Metadata in the form of NAME=VALUE pairs. Can be specified multiple times.
--mount-point string New volume mount point
-p, --port strings The external ports and handlers for services, in the format: port[:machinePort][/protocol[:handler[:handler...]]])
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_mpg_create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ fly mpg create [flags]
--pg-major-version int The major version of Postgres to use for the Postgres cluster. Supported versions are 16 and 17. (default 16)
--plan string The plan to use for the Postgres cluster: Basic, Starter, Launch, Scale, Performance
-r, --region string The target region (see 'flyctl platform regions')
--volume-size int The volume size in GB (default 10)
--volume-size int Initial volume size in GB (default 10)
```
## Global Options

Expand Down
4 changes: 2 additions & 2 deletions flyctl/cmd/fly_redis_update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ fly redis update <name> [flags]
## Options

```
--disable-prodpack Disable the ProdPack add-on
--enable-prodpack Enable ProdPack add-on for additional features ($200/mo)
--disable-prodpack Disable the ProdPack add-on, leaving every other setting untouched
--enable-prodpack Enable ProdPack add-on for additional features ($200/mo), leaving every other setting untouched
-h, --help help for update
-o, --org string The target Fly.io organization
-r, --region string The target region (see 'flyctl platform regions')
Expand Down
1 change: 0 additions & 1 deletion flyctl/cmd/fly_tokens_create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ fly tokens create [command] [flags]
```
## Available Commands
* [deploy](/flyctl/cmd/fly_tokens_create_deploy) - Create deploy tokens
* [litefs-cloud](/flyctl/cmd/fly_tokens_create_litefs-cloud) - Create LiteFS Cloud tokens
* [machine-exec](/flyctl/cmd/fly_tokens_create_machine-exec) - Create a machine exec token
* [org](/flyctl/cmd/fly_tokens_create_org) - Create org deploy tokens
* [readonly](/flyctl/cmd/fly_tokens_create_readonly) - Create read-only org tokens
Expand Down
4 changes: 0 additions & 4 deletions flyctl/cmd/fly_tokens_revoke_supplied.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,18 @@ Does not clear local configuration or unset environment variables.
```
fly tokens revoke supplied [flags]
```

## Options

```
-h, --help help for supplied
```

## Global Options

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

## See Also

* [fly tokens revoke](/flyctl/cmd/fly_tokens_revoke) - Revoke tokens

1 change: 1 addition & 0 deletions flyctl/cmd/fly_wireguard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ fly wireguard [command] [flags]
* [list](/flyctl/cmd/fly_wireguard_list) - List all WireGuard peer connections
* [remove](/flyctl/cmd/fly_wireguard_remove) - Remove a WireGuard peer connection
* [reset](/flyctl/cmd/fly_wireguard_reset) - Reset WireGuard peer connection for an organization
* [token-mode](/flyctl/cmd/fly_wireguard_token-mode) - Enable or disable token-mode WireGuard peers
* [websockets](/flyctl/cmd/fly_wireguard_websockets) - Enable or disable WireGuard tunneling over WebSockets

## Options
Expand Down
26 changes: 26 additions & 0 deletions flyctl/cmd/fly_wireguard_token-mode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: fly wireguard token-mode
source_url: https://fly.io/docs/flyctl/wireguard-token-mode/
---

Enable or disable token-mode WireGuard peers

## Usage
```
fly wireguard token-mode [enable|disable] [flags]
```
## Options

```
-h, --help help for token-mode
```
## Global Options

```
-t, --access-token string Fly API Access Token
--debug Print additional logs and traces
--verbose Verbose output
```
## See Also

* [fly wireguard](/flyctl/cmd/fly_wireguard) - Commands that manage WireGuard peer connections
Loading