Skip to content

Commit

Permalink
Merge pull request superfly#575 from superfly/flyctl-docs_master
Browse files Browse the repository at this point in the history
[flybot] Fly CLI docs update
  • Loading branch information
jsierles committed Feb 6, 2023
2 parents 14f2daa + ca290cb commit 39c58e2
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
2 changes: 2 additions & 0 deletions flyctl/cmd/flyctl_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ flyctl deploy [WORKING_DIRECTORY] [flags]
--ignorefile string Path to a Docker ignore file. Defaults to the .dockerignore file in the working directory.
-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}".
--lease-timeout int Seconds to lease individual machines while running deployment. All machines are leased at the beginning and released at the end, so this needs to be as long as the entire deployment. flyctl releases leases in most cases. (default 1800)
--local-only Only perform builds locally using the local docker daemon
--nixpacks Deploy using nixpacks to build the image
--no-cache Do not use the build cache when building the image
Expand All @@ -33,6 +34,7 @@ flyctl deploy [WORKING_DIRECTORY] [flags]
-r, --region string The target region (see 'flyctl platform regions')
--remote-only Perform builds on a remote builder instance instead of using the local docker daemon
--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.
--wait-timeout int Seconds to wait for individual machines to transition states and become healthy. (default 120)
~~~

## Global Options
Expand Down
5 changes: 5 additions & 0 deletions flyctl/cmd/flyctl_launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,15 @@ flyctl launch [flags]
--dockerfile string Path to a Dockerfile. Defaults to the Dockerfile in the working directory.
--dockerignore-from-gitignore If a .dockerignore does not exist, create one from .gitignore files
-e, --env strings Set of environment variables in the form of NAME=VALUE pairs. Can be specified multiple times.
--force-machines Use the Apps v2 platform built with Machines
--force-nomad Use the Apps v1 platform built with Nomad
--generate-name Always generate a name for the app, without prompting
-h, --help help for launch
--ignorefile string Path to a Docker ignore file. Defaults to the .dockerignore file in the working directory.
-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)
--lease-timeout int Seconds to lease individual machines while running deployment. All machines are leased at the beginning and released at the end, so this needs to be as long as the entire deployment. flyctl releases leases in most cases. (default 1800)
--local-only Only perform builds locally using the local docker daemon
--name string Name of the new app
--nixpacks Deploy using nixpacks to build the image
Expand All @@ -35,6 +39,7 @@ flyctl launch [flags]
-r, --region string The target region (see 'flyctl platform regions')
--remote-only Perform builds on a remote builder instance instead of using the local docker daemon
--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.
--wait-timeout int Seconds to wait for individual machines to transition states and become healthy. (default 120)
~~~

## Global Options
Expand Down
6 changes: 5 additions & 1 deletion flyctl/cmd/flyctl_machine_clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,22 @@ Clone a Fly machine

## Usage
~~~
flyctl machine clone <id> [flags]
flyctl machine clone <machine_id> [flags]
~~~

## Options

~~~
-a, --app string Application name
--attach-volume string Existing volume to attach to the new machine
--clear-auto-destroy Disable auto destroy setting on new machine
--clear-cmd Set empty CMD on the new machine so it uses default CMD for the image
-c, --config string Path to application configuration file
--from-snapshot string Clone attached volumes and restore from snapshot, use 'last' for most recent snapshot. The default is an empty volume
-h, --help help for clone
--name string Optional name for the new machine
--override-cmd string Set CMD on the new machine to this value
--process-group string For machines that are part of Fly Apps v2 does a regular clone and changes the process group to what is specified here
--region string Target region for the new machine
~~~

Expand Down

0 comments on commit 39c58e2

Please sign in to comment.