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

Revert "[flybot] Fly CLI docs update" #1855

Merged
merged 1 commit into from
Oct 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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
64 changes: 64 additions & 0 deletions flyctl/cmd/fly.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
This is flyctl, the Fly.io command line interface.

## Usage
~~~
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.
* [auth](/docs/flyctl/auth/) - Manage authentication
* [certs](/docs/flyctl/certs/) - Manage certificates
* [checks](/docs/flyctl/checks/) - Manage health checks
* [config](/docs/flyctl/config/) - Manage an app's configuration
* [console](/docs/flyctl/console/) - Run a console in a new or existing machine
* [consul](/docs/flyctl/consul/) - Enable and manage Consul clusters
* [dashboard](/docs/flyctl/dashboard/) - Open web browser on Fly Web UI for this app
* [deploy](/docs/flyctl/deploy/) - Deploy Fly applications
* [dig](/docs/flyctl/dig/) - Make DNS requests against Fly.io's internal DNS server
* [docs](/docs/flyctl/docs/) - View Fly documentation
* [doctor](/docs/flyctl/doctor/) - The DOCTOR command allows you to debug your Fly environment
* [extensions](/docs/flyctl/extensions/) - Extensions are additional functionality that can be added to your Fly apps
* [image](/docs/flyctl/image/) - Manage app image
* [incidents](/docs/flyctl/incidents/) - Show incidents
* [ips](/docs/flyctl/ips/) - Manage IP addresses for apps
* [jobs](/docs/flyctl/jobs/) - Show jobs at Fly.io
* [launch](/docs/flyctl/launch/) - Create and configure a new app from source code or a Docker image
* [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 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
* [postgres](/docs/flyctl/postgres/) - Manage Postgres clusters.
* [proxy](/docs/flyctl/proxy/) - Proxies connections to a Fly Machine.
* [redis](/docs/flyctl/redis/) - Launch and manage Redis databases managed by Upstash.com
* [releases](/docs/flyctl/releases/) - List app releases
* [scale](/docs/flyctl/scale/) - Scale app resources
* [secrets](/docs/flyctl/secrets/) - Manage application secrets with the set and unset commands.
* [services](/docs/flyctl/services/) - Show the application's services
* [settings](/docs/flyctl/settings/) - Manage flyctl settings
* [sftp](/docs/flyctl/sftp/) - Get or put files from a remote VM.
* [ssh](/docs/flyctl/ssh/) - Use SSH to log into or run commands on Machines
* [status](/docs/flyctl/status/) - Show app status
* [storage](/docs/flyctl/storage/) - Provision and manage Tigris object storage buckets
* [synthetics](/docs/flyctl/synthetics/) - Synthetic monitoring
* [tokens](/docs/flyctl/tokens/) - Manage Fly.io API tokens
* [version](/docs/flyctl/version/) - Show version information for the flyctl command
* [volumes](/docs/flyctl/volumes/) - Manage Fly Volumes.
* [wireguard](/docs/flyctl/wireguard/) - Commands that manage WireGuard peer connections

## Options

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

## See Also


14 changes: 7 additions & 7 deletions flyctl/cmd/main_agent.md → flyctl/cmd/fly_agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Generally, the agent starts and stops automatically. These commands are useful f

## Usage
~~~
main agent [command] [flags]
fly agent [command] [flags]
~~~

## Available Commands
* [ping](/docs/flyctl/main-agent-ping/) - Ping the Fly agent
* [restart](/docs/flyctl/main-agent-restart/) - Restart the Fly agent
* [run](/docs/flyctl/main-agent-run/) - Run the Fly agent in the foreground
* [start](/docs/flyctl/main-agent-start/) - Start the Fly agent
* [stop](/docs/flyctl/main-agent-stop/) - Stop the Fly agent
* [ping](/docs/flyctl/agent-ping/) - Ping the Fly agent
* [restart](/docs/flyctl/agent-restart/) - Restart the Fly agent
* [run](/docs/flyctl/agent-run/) - Run the Fly agent in the foreground
* [start](/docs/flyctl/agent-start/) - Start the Fly agent
* [stop](/docs/flyctl/agent-stop/) - Stop the Fly agent

## Options

Expand All @@ -31,5 +31,5 @@ main agent [command] [flags]

## See Also

* [main](/docs/flyctl/main/) - The Fly.io command line interface
* [fly](/docs/flyctl/help/) - The Fly.io command line interface

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Ping the Fly agent

## Usage
~~~
main agent ping [flags]
fly agent ping [flags]
~~~

## Options
Expand All @@ -23,5 +23,5 @@ main agent ping [flags]

## See Also

* [main agent](/docs/flyctl/main-agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections
* [fly agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Restart the Fly agent

## Usage
~~~
main agent restart [flags]
fly agent restart [flags]
~~~

## Options
Expand All @@ -22,5 +22,5 @@ main agent restart [flags]

## See Also

* [main agent](/docs/flyctl/main-agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections
* [fly agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections

4 changes: 2 additions & 2 deletions flyctl/cmd/main_agent_run.md → flyctl/cmd/fly_agent_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Run the Fly agent in the foreground

## Usage
~~~
main agent run [flags]
fly agent run [flags]
~~~

## Options
Expand All @@ -22,5 +22,5 @@ main agent run [flags]

## See Also

* [main agent](/docs/flyctl/main-agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections
* [fly agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Start the Fly agent

## Usage
~~~
main agent start [flags]
fly agent start [flags]
~~~

## Options
Expand All @@ -22,5 +22,5 @@ main agent start [flags]

## See Also

* [main agent](/docs/flyctl/main-agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections
* [fly agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Stop the Fly agent

## Usage
~~~
main agent stop [flags]
fly agent stop [flags]
~~~

## Options
Expand All @@ -22,5 +22,5 @@ main agent stop [flags]

## See Also

* [main agent](/docs/flyctl/main-agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections
* [fly agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections

35 changes: 35 additions & 0 deletions flyctl/cmd/fly_apps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
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 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.
* [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.

## Options

~~~
-h, --help help for apps
~~~

## Global Options

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

## See Also

* [fly](/docs/flyctl/help/) - The Fly.io command line interface

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ fetch one with 'fly config save -a <app_name>'.

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

## Options
Expand All @@ -28,5 +28,5 @@ main apps create <app name> [flags]

## See Also

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

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Delete one or more applications from the Fly platform.

## Usage
~~~
main apps destroy <app name(s)> [flags]
fly apps destroy <app name(s)> [flags]
~~~

## Options
Expand All @@ -22,5 +22,5 @@ main apps destroy <app name(s)> [flags]

## See Also

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

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ View application errors on Sentry.io

## Usage
~~~
main apps errors [flags]
fly apps errors [flags]
~~~

## Options
Expand All @@ -23,5 +23,5 @@ main apps errors [flags]

## See Also

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

4 changes: 2 additions & 2 deletions flyctl/cmd/main_apps_list.md → flyctl/cmd/fly_apps_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ the name, owner (org), status, and date/time of latest deploy for each app.

## Usage
~~~
main apps list [flags]
fly apps list [flags]
~~~

## Options
Expand All @@ -28,5 +28,5 @@ main apps list [flags]

## See Also

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

4 changes: 2 additions & 2 deletions flyctl/cmd/main_apps_move.md → flyctl/cmd/fly_apps_move.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ For details, see https://fly.io/docs/apps/move-app-org/.

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

## Options
Expand All @@ -26,5 +26,5 @@ main apps move <app name> [flags]

## See Also

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

4 changes: 2 additions & 2 deletions flyctl/cmd/main_apps_open.md → flyctl/cmd/fly_apps_open.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ to the root URL of the deployed application.

## Usage
~~~
main apps open [RELATIVE_URI] [flags]
fly apps open [RELATIVE_URI] [flags]
~~~

## Options
Expand All @@ -25,5 +25,5 @@ main apps open [RELATIVE_URI] [flags]

## See Also

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

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ including type, when, success/fail and which user triggered the release.

## Usage
~~~
main apps releases [flags]
fly apps releases [flags]
~~~

## Options
Expand All @@ -27,5 +27,5 @@ main apps releases [flags]

## See Also

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

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Restart an application. Perform a rolling restart against all running Machines.

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

## Options
Expand All @@ -23,5 +23,5 @@ main apps restart <app name> [flags]

## See Also

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

14 changes: 7 additions & 7 deletions flyctl/cmd/main_auth.md → flyctl/cmd/fly_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ If you do have an account, begin with the AUTH LOGIN subcommand.

## Usage
~~~
main auth [command] [flags]
fly auth [command] [flags]
~~~

## Available Commands
* [docker](/docs/flyctl/main-auth-docker/) - Authenticate docker
* [login](/docs/flyctl/main-auth-login/) - Log in a user
* [logout](/docs/flyctl/main-auth-logout/) - Logs out the currently logged in user
* [signup](/docs/flyctl/main-auth-signup/) - Create a new fly account
* [whoami](/docs/flyctl/main-auth-whoami/) - Displays the users email address/service identity currently
* [docker](/docs/flyctl/auth-docker/) - Authenticate docker
* [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
* [whoami](/docs/flyctl/auth-whoami/) - Displays the users email address/service identity currently
authenticated and in use.


Expand All @@ -33,5 +33,5 @@ authenticated and in use.

## See Also

* [main](/docs/flyctl/main/) - The Fly.io command line interface
* [fly](/docs/flyctl/help/) - The Fly.io command line interface

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ the docker cli.

## Usage
~~~
main auth docker [flags]
fly auth docker [flags]
~~~

## Options
Expand All @@ -24,5 +24,5 @@ main auth docker [flags]

## See Also

* [main auth](/docs/flyctl/main-auth/) - Manage authentication
* [fly auth](/docs/flyctl/auth/) - Manage authentication

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ browser-based authentication.

## Usage
~~~
main auth login [flags]
fly auth login [flags]
~~~

## Options
Expand All @@ -28,5 +28,5 @@ main auth login [flags]

## See Also

* [main auth](/docs/flyctl/main-auth/) - Manage authentication
* [fly auth](/docs/flyctl/auth/) - Manage authentication

Loading
Loading