Skip to content

Commit

Permalink
Fix typo in the cli help message (#122)
Browse files Browse the repository at this point in the history
* Add support for parsable output

* Add alias `--json` to `--raw` option

* Fix typo in description
  • Loading branch information
ekouts authored Aug 28, 2024
1 parent 5967df4 commit be428e8
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions firecrest/cli/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ def services(
name: Optional[str] = typer.Option(
None, "-n", "--name", help="Get information for only one service."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Provides information for the services of FirecREST"""
try:
Expand Down Expand Up @@ -156,7 +156,7 @@ def systems(
name: Optional[str] = typer.Option(
None, "-n", "--name", help="Get information for only one system."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Provides information for the available systems in FirecREST"""
try:
Expand Down Expand Up @@ -186,7 +186,7 @@ def systems(

@app.command(rich_help_panel="Status commands")
def parameters(
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Configurable parameters of FirecREST"""
try:
Expand Down Expand Up @@ -233,7 +233,7 @@ def filesystems(
help="The name of the system where the filesystems belongs to.",
envvar="FIRECREST_SYSTEM",
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Information about the filesystems that are available through FirecREST"""
try:
Expand Down Expand Up @@ -266,7 +266,7 @@ def tasks(
pager: Optional[bool] = typer.Option(
True, help="Display the output in a pager application."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieve information about the FirecREST tasks of the users"""
try:
Expand Down Expand Up @@ -327,7 +327,7 @@ def ls(
"--recursive",
help="Recursively list directories encountered.",
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""List directory contents"""
try:
Expand Down Expand Up @@ -583,7 +583,7 @@ def stat(
),
path: str = typer.Argument(..., help="The absolute target path."),
deref: bool = typer.Option(False, "-L", "--dereference", help="Follow links."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Use the stat linux application to determine the status of a file on the system's filesystem"""
try:
Expand Down Expand Up @@ -1434,7 +1434,7 @@ def poll(
None,
help="End time (and/or date) of job's query. Allowed formats are `HH:MM\[:SS] \[AM|PM]` or `MMDD\[YY]` or `MM/DD\[/YY]` or `MM.DD\[.YY]` or `MM/DD\[/YY]-HH:MM\[:SS]` or `YYYY-MM-DD\[THH:MM\[:SS]]`.",
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieve information about submitted jobs.
This call uses the `sacct` command
Expand Down Expand Up @@ -1477,7 +1477,7 @@ def poll_active(
jobs: Optional[List[str]] = typer.Argument(
None, help="List of job IDs to display."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieves information about active jobs.
This call uses the `squeue -u <username>` command
Expand Down Expand Up @@ -1520,7 +1520,7 @@ def get_nodes(
nodes: Optional[List[str]] = typer.Argument(
None, help="List of specific compute nodes to query."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieves information about the compute nodes.
This call uses the `scontrol show nodes` command
Expand Down Expand Up @@ -1568,7 +1568,7 @@ def get_partitions(
partitions: Optional[List[str]] = typer.Argument(
None, help="List of specific partitions to query."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieves information about the partitions.
This call uses the `scontrol show partitions` command
Expand Down Expand Up @@ -1637,7 +1637,7 @@ def get_reservations(
reservations: Optional[List[str]] = typer.Argument(
None, help="List of specific reservations to query."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieves information about the reservations.
This call uses the `scontrol show reservations` command
Expand Down

0 comments on commit be428e8

Please sign in to comment.