Skip to content

Commit

Permalink
Merge pull request #1070 from superfly/flyctl-docs_v0.1.102
Browse files Browse the repository at this point in the history
[flybot] Fly CLI docs update
  • Loading branch information
docs-syncer[bot] authored Sep 26, 2023
2 parents 37dd9fb + c2f0420 commit cdeeef6
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 6 deletions.
8 changes: 8 additions & 0 deletions flyctl/cmd/flyctl_console.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,17 @@ flyctl console [flags]

~~~
-a, --app string Application name
-C, --command string command to run on SSH session
-c, --config string Path to application configuration file
--dockerfile string Path to a Dockerfile. Defaults to the Dockerfile in the working directory.
--entrypoint string ENTRYPOINT replacement
-e, --env stringArray Set of environment variables in the form of NAME=VALUE pairs. Can be specified multiple times.
-h, --help help for console
-i, --image string image to use (default: current release)
--machine string Run the console in the existing machine with the specified ID
-p, --port strings Publish ports, format: port[:machinePort][/protocol[:handler[:handler...]]])
i.e.: --port 80/tcp --port 443:80/tcp:http:tls --port 5432/tcp:pg_tls
To remove a port mapping use '-' as handler, i.e.: --port 80/tcp:-
-r, --region string The target region (see 'flyctl platform regions')
-s, --select Select the machine on which to execute the console from a list
-u, --user string Unix username to connect as (default "root")
Expand Down
4 changes: 2 additions & 2 deletions flyctl/cmd/flyctl_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ flyctl deploy [WORKING_DIRECTORY] [flags]
--immediate-max-concurrent int Maximum number of machines to update concurrently when using the immediate deployment strategy. (default 16)
--label stringArray Add custom metadata to an image via docker labels
--lease-timeout int Seconds 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 13)
--local-only Only perform builds locally using the local docker daemon
--local-only Perform builds locally using the local docker daemon. The default is --remote-only.
--max-unavailable float Max number of unavailable machines during rolling updates. A number between 0 and 1 means percent of total machines (default 0.33)
--nixpacks Deploy using nixpacks to build the image
--no-cache Do not use the build cache when building the image
Expand All @@ -44,7 +44,7 @@ flyctl deploy [WORKING_DIRECTORY] [flags]
--push Push image to registry after build is complete
-r, --region string The target region (see 'flyctl platform regions')
--release-command-timeout string Seconds to wait for a release command finish running, or 'none' to disable. (default "300")
--remote-only Perform builds on a remote builder instance instead of using the local docker daemon
--remote-only Perform builds on a remote builder instance instead of using the local docker daemon. This is the default. Use --local-only to build locally.
--smoke-checks Perform smoke checks during deployment (default true)
--strategy string The strategy for replacing running instances. Options are canary, rolling, bluegreen, or immediate. Default is canary, or rolling when max-per-region is set.
--update-only Do not create Machines for new process groups
Expand Down
4 changes: 2 additions & 2 deletions flyctl/cmd/flyctl_launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ flyctl launch [flags]
--internal-port int Set internal_port for all services in the generated fly.toml (default -1)
--label stringArray Add custom metadata to an image via docker labels
--lease-timeout int Seconds 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 13)
--local-only Only perform builds locally using the local docker daemon
--local-only Perform builds locally using the local docker daemon. The default is --remote-only.
--max-unavailable float Max number of unavailable machines during rolling updates. A number between 0 and 1 means percent of total machines (default 0.33)
--name string Name of the new app
--nixpacks Deploy using nixpacks to build the image
Expand All @@ -47,7 +47,7 @@ flyctl launch [flags]
--push Push image to registry after build is complete
-r, --region string The target region (see 'flyctl platform regions')
--release-command-timeout string Seconds to wait for a release command finish running, or 'none' to disable. (default "300")
--remote-only Perform builds on a remote builder instance instead of using the local docker daemon
--remote-only Perform builds on a remote builder instance instead of using the local docker daemon. This is the default. Use --local-only to build locally.
--reuse-app Continue even if app name clashes with an existent app
--smoke-checks Perform smoke checks during deployment (default true)
--strategy string The strategy for replacing running instances. Options are canary, rolling, bluegreen, or immediate. Default is canary, or rolling when max-per-region is set.
Expand Down
4 changes: 2 additions & 2 deletions flyctl/cmd/flyctl_turboku.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ flyctl turboku <heroku-app-name> <heroku-api-token> [flags]
--keep keep the app directory after deployment
--label stringArray Add custom metadata to an image via docker labels
--lease-timeout int Seconds 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 13)
--local-only Only perform builds locally using the local docker daemon
--local-only Perform builds locally using the local docker daemon. The default is --remote-only.
--max-unavailable float Max number of unavailable machines during rolling updates. A number between 0 and 1 means percent of total machines (default 0.33)
--name string the name of the new app
--nixpacks Deploy using nixpacks to build the image
Expand All @@ -43,7 +43,7 @@ flyctl turboku <heroku-app-name> <heroku-api-token> [flags]
--push Push image to registry after build is complete
-r, --region string The target region (see 'flyctl platform regions')
--release-command-timeout string Seconds to wait for a release command finish running, or 'none' to disable. (default "300")
--remote-only Perform builds on a remote builder instance instead of using the local docker daemon
--remote-only Perform builds on a remote builder instance instead of using the local docker daemon. This is the default. Use --local-only to build locally.
--smoke-checks Perform smoke checks during deployment (default true)
--strategy string The strategy for replacing running instances. Options are canary, rolling, bluegreen, or immediate. Default is canary, or rolling when max-per-region is set.
--vm-cpu-kind string The kind of CPU to use ('shared' or 'performance')
Expand Down

0 comments on commit cdeeef6

Please sign in to comment.