Skip to content

Commit acfd9e2

Browse files
authored
πŸ’„ Improve help menus (#245)
1 parent 49b6ae1 commit acfd9e2

10 files changed

Lines changed: 27 additions & 9 deletions

File tree

β€Žsrc/fastapi_cloud_cli/cli.pyβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def version_callback(value: bool) -> None:
3333

3434
cloud_app = typer.Typer(
3535
rich_markup_mode="rich",
36-
help="Manage [bold]FastAPI[/bold] Cloud deployments. πŸš€",
36+
help="Manage [bold]FastAPI[/bold] Cloud deployments.",
3737
no_args_is_help=True,
3838
)
3939

β€Žsrc/fastapi_cloud_cli/commands/apps/__init__.pyβ€Ž

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
from fastapi_cloud_cli.commands.apps.unlink import unlink_app
88
from fastapi_cloud_cli.commands.logs import logs
99

10-
apps_app = typer.Typer(no_args_is_help=True)
10+
apps_app = typer.Typer(
11+
no_args_is_help=True,
12+
help="Manage your FastAPI Cloud apps.",
13+
)
1114
apps_app.command("create")(create_app)
1215
apps_app.command("get")(get_app)
1316
apps_app.command("link")(link_app)

β€Žsrc/fastapi_cloud_cli/commands/auth/__init__.pyβ€Ž

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
from fastapi_cloud_cli.commands.auth import wait as wait_command
44
from fastapi_cloud_cli.commands.login import login
55

6-
auth_app = typer.Typer(no_args_is_help=True)
6+
auth_app = typer.Typer(
7+
no_args_is_help=True,
8+
help="Authenticate with FastAPI Cloud.",
9+
)
710

811
auth_app.command()(login)
912
auth_app.command("wait")(wait_command.wait)

β€Žsrc/fastapi_cloud_cli/commands/deploy/command.pyβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ def deploy(
129129
json_output: JsonOutputOption = False,
130130
) -> Any:
131131
"""
132-
Deploy a [bold]FastAPI[/bold] app to FastAPI Cloud. πŸš€
132+
Deploy a [bold]FastAPI[/bold] app to FastAPI Cloud.
133133
"""
134134
logger.debug("Deploy command started")
135135
logger.debug(

β€Žsrc/fastapi_cloud_cli/commands/deployments.pyβ€Ž

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,10 @@ def _render_build_log_error(
308308
toolkit.print_hint(hint)
309309

310310

311-
deployments_app = typer.Typer(no_args_is_help=True)
311+
deployments_app = typer.Typer(
312+
no_args_is_help=True,
313+
help="Manage the deployments of your app.",
314+
)
312315

313316

314317
@deployments_app.command("get")

β€Žsrc/fastapi_cloud_cli/commands/env/__init__.pyβ€Ž

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
from fastapi_cloud_cli.commands.env.list import list_variables
66
from fastapi_cloud_cli.commands.env.set import set
77

8-
env_app = typer.Typer()
8+
env_app = typer.Typer(
9+
no_args_is_help=True,
10+
help="Manage the environment variables of your app.",
11+
)
912
env_app.command("list")(list_variables)
1013
env_app.command("get")(get_variable)
1114
env_app.command()(delete)

β€Žsrc/fastapi_cloud_cli/commands/login.pyβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ def login(
7878
json_output: JsonOutputOption = False,
7979
) -> Any:
8080
"""
81-
Login to FastAPI Cloud. πŸš€
81+
Login to FastAPI Cloud.
8282
"""
8383
if json_output:
8484
with get_rich_toolkit(json_output=json_output, minimal=True) as toolkit:

β€Žsrc/fastapi_cloud_cli/commands/logout.pyβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
def logout() -> None:
66
"""
7-
Logout from FastAPI Cloud. πŸš€
7+
Logout from FastAPI Cloud.
88
"""
99
with get_rich_toolkit() as toolkit:
1010
toolkit.print_title("FastAPI Cloud")

β€Žsrc/fastapi_cloud_cli/commands/teams/__init__.pyβ€Ž

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,10 @@ def _render_teams_list_output(data: TeamsListOutput, toolkit: RichToolkit) -> No
8181
toolkit.print(table, bullet=False)
8282

8383

84-
teams_app = typer.Typer(no_args_is_help=True)
84+
teams_app = typer.Typer(
85+
no_args_is_help=True,
86+
help="Manage your FastAPI Cloud teams.",
87+
)
8588

8689

8790
@teams_app.command("list")

β€Žsrc/fastapi_cloud_cli/commands/whoami.pyβ€Ž

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ def _render_whoami_output(data: WhoAmIOutput, toolkit: RichToolkit) -> None:
3131
def whoami(
3232
json_output: JsonOutputOption = False,
3333
) -> Any:
34+
"""
35+
Show the currently logged in user.
36+
"""
3437
identity = Identity()
3538

3639
with get_rich_toolkit(json_output=json_output) as toolkit:

0 commit comments

Comments
Β (0)