Skip to content

[flybot] Fly CLI docs update #2014

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 23, 2025
Merged

[flybot] Fly CLI docs update #2014

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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_console.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Run a console in a new or existing machine. The console command is

Check warning on line 1 in flyctl/cmd/fly_console.md

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
[Fly.Machine] Use 'Machine' instead of ' machine'.

Raw Output:
{"message": "[Fly.Machine] Use 'Machine' instead of ' machine'.", "location": {"path": "flyctl/cmd/fly_console.md", "range": {"start": {"line": 1, "column": 35}}}, "severity": "INFO"}
specified by the `console_command` configuration field. By default, a
new machine is created by default using the app's most recently deployed

Check warning on line 3 in flyctl/cmd/fly_console.md

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
[Fly.Machine] Use 'Machine' instead of ' machine'.

Raw Output:
{"message": "[Fly.Machine] Use 'Machine' instead of ' machine'.", "location": {"path": "flyctl/cmd/fly_console.md", "range": {"start": {"line": 3, "column": 4}}}, "severity": "INFO"}
image. An existing machine can be used instead with --machine.

Check warning on line 4 in flyctl/cmd/fly_console.md

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
[Fly.Machine] Use 'Machine' instead of ' machine'.

Raw Output:
{"message": "[Fly.Machine] Use 'Machine' instead of ' machine'.", "location": {"path": "flyctl/cmd/fly_console.md", "range": {"start": {"line": 4, "column": 19}}}, "severity": "INFO"}

## Usage
~~~
Expand Down Expand Up @@ -29,7 +29,7 @@
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.
-s, --select Select the machine and container on which to execute the console from a list.
-u, --user string Unix username to connect as (default "root")
--vm-cpu-kind string The kind of CPU to use ('shared' or 'performance')
--vm-cpus int Number of CPUs
Expand Down
Loading