From f33b3559e1ebc50e8be6d54f8512bd9b90a5ed59 Mon Sep 17 00:00:00 2001 From: zgoldberg22 Date: Thu, 14 Sep 2023 15:42:23 -0400 Subject: [PATCH 1/8] cli docs --- cli_docs/README.md | 38 ++++++ cli_docs/configurations.md | 99 +++++++++++++++ cli_docs/constraints.md | 83 ++++++++++++ cli_docs/expansion.md | 230 ++++++++++++++++++++++++++++++++++ cli_docs/generate_cli_docs.py | 25 ++++ cli_docs/metadata.md | 80 ++++++++++++ cli_docs/models.md | 82 ++++++++++++ cli_docs/plans.md | 210 +++++++++++++++++++++++++++++++ cli_docs/scheduling.md | 64 ++++++++++ 9 files changed, 911 insertions(+) create mode 100644 cli_docs/README.md create mode 100644 cli_docs/configurations.md create mode 100644 cli_docs/constraints.md create mode 100644 cli_docs/expansion.md create mode 100644 cli_docs/generate_cli_docs.py create mode 100644 cli_docs/metadata.md create mode 100644 cli_docs/models.md create mode 100644 cli_docs/plans.md create mode 100644 cli_docs/scheduling.md diff --git a/cli_docs/README.md b/cli_docs/README.md new file mode 100644 index 00000000..954ca9a8 --- /dev/null +++ b/cli_docs/README.md @@ -0,0 +1,38 @@ +# **Aerie-CLI Documentation** + +## **CLI Commands**: + +- [`configurations`](configurations.md) +- [`constraints`](constraints.md) +- [`expansion`](expansion.md) +- [`metadata`](metadata.md) +- [`models`](models.md) +- [`plans`](plans.md) +- [`scheduling`](scheduling.md) + +--- + +## **How to Generate Documentation** +### **Documentation for Individual Command with Typer CLI** +Usage: + +```$ typer script.py utils docs --name TEXT --output FILE``` + +Subcommands: +- `utils` +- `docs` + +Options: +- `--name TEXT` : name of the CLI program to use in docs + - *Ex: `--name 'aerie-cli plans'`* +- `--output FILE` : output file to write docs to + - *Ex: `--output 'plans.md'`* + +
+ +### **Documentation for All Individual Commands** +Generate documentation for all Aerie-CLI commands using the `generate_cli_docs` script. + +Usage: + +```$ python3 generate_cli_docs.py``` \ No newline at end of file diff --git a/cli_docs/configurations.md b/cli_docs/configurations.md new file mode 100644 index 00000000..f666153b --- /dev/null +++ b/cli_docs/configurations.md @@ -0,0 +1,99 @@ +# `aerie-cli configurations` + +**Usage**: + +```console +$ aerie-cli configurations [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--install-completion`: Install completion for the current shell. +* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. +* `--help`: Show this message and exit. + +**Commands**: + +* `clean`: Remove all persistent aerie-cli files +* `create`: Define a configuration for an Aerie host +* `delete`: Delete an Aerie host configuration +* `list`: List available Aerie host configurations +* `load`: Load one or more configurations from a... + +## `aerie-cli configurations clean` + +Remove all persistent aerie-cli files + +**Usage**: + +```console +$ aerie-cli configurations clean [OPTIONS] +``` + +**Options**: + +* `--not-interactive / --no-not-interactive`: Disable interactive prompt [default: no-not-interactive] +* `--help`: Show this message and exit. + +## `aerie-cli configurations create` + +Define a configuration for an Aerie host + +**Usage**: + +```console +$ aerie-cli configurations create [OPTIONS] +``` + +**Options**: + +* `--name NAME`: Name for this configuration [required] +* `--graphql-url GRAPHQL_URL`: URL of GraphQL API endpoint [required] +* `--gateway-url GATEWAY_URL`: URL of Aerie Gateway [required] +* `--username USERNAME`: Username for authentication +* `--help`: Show this message and exit. + +## `aerie-cli configurations delete` + +Delete an Aerie host configuration + +**Usage**: + +```console +$ aerie-cli configurations delete [OPTIONS] +``` + +**Options**: + +* `-n, --name NAME`: Name for this configuration +* `--help`: Show this message and exit. + +## `aerie-cli configurations list` + +List available Aerie host configurations + +**Usage**: + +```console +$ aerie-cli configurations list [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +## `aerie-cli configurations load` + +Load one or more configurations from a JSON file + +**Usage**: + +```console +$ aerie-cli configurations load [OPTIONS] +``` + +**Options**: + +* `-i, --filename PATH`: Name of input JSON file [required] +* `--allow-overwrite`: Allow overwriting existing configurations +* `--help`: Show this message and exit. diff --git a/cli_docs/constraints.md b/cli_docs/constraints.md new file mode 100644 index 00000000..4a07452a --- /dev/null +++ b/cli_docs/constraints.md @@ -0,0 +1,83 @@ +# `aerie-cli constraints` + +**Usage**: + +```console +$ aerie-cli constraints [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--install-completion`: Install completion for the current shell. +* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. +* `--help`: Show this message and exit. + +**Commands**: + +* `delete`: Delete a constraint +* `update`: Update a constraint +* `upload`: Upload a constraint +* `violations` + +## `aerie-cli constraints delete` + +Delete a constraint + +**Usage**: + +```console +$ aerie-cli constraints delete [OPTIONS] +``` + +**Options**: + +* `--id INTEGER`: The constraint id to be deleted [required] +* `--help`: Show this message and exit. + +## `aerie-cli constraints update` + +Update a constraint + +**Usage**: + +```console +$ aerie-cli constraints update [OPTIONS] +``` + +**Options**: + +* `--id INTEGER`: The constraint id to be modifyed [required] +* `--constraint-file TEXT`: The new constraint for the id [required] +* `--help`: Show this message and exit. + +## `aerie-cli constraints upload` + +Upload a constraint + +**Usage**: + +```console +$ aerie-cli constraints upload [OPTIONS] +``` + +**Options**: + +* `--model-id INTEGER`: The model id associated with the constraint (do not input plan id) +* `--plan-id INTEGER`: The plan id associated with the constraint (do not input model id) +* `--name TEXT`: The name of the constraint [required] +* `--description TEXT`: The description of the constraint +* `--constraint-file TEXT`: The file that holds the constraint [required] +* `--help`: Show this message and exit. + +## `aerie-cli constraints violations` + +**Usage**: + +```console +$ aerie-cli constraints violations [OPTIONS] +``` + +**Options**: + +* `--plan-id INTEGER`: The plan id for the violation [required] +* `--help`: Show this message and exit. diff --git a/cli_docs/expansion.md b/cli_docs/expansion.md new file mode 100644 index 00000000..4f2d7443 --- /dev/null +++ b/cli_docs/expansion.md @@ -0,0 +1,230 @@ +# `aerie-cli expansion` + +**Usage**: + +```console +$ aerie-cli expansion [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--install-completion`: Install completion for the current shell. +* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. +* `--help`: Show this message and exit. + +**Commands**: + +* `runs`: Commands for expansion runs +* `sequences`: Commands for sequences +* `sets`: Commands for expansion sets + +## `aerie-cli expansion runs` + +Commands for expansion runs + +**Usage**: + +```console +$ aerie-cli expansion runs [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `create`: Run command expansion on a simulation dataset +* `list`: List expansion runs for a given plan or... + +### `aerie-cli expansion runs create` + +Run command expansion on a simulation dataset + +**Usage**: + +```console +$ aerie-cli expansion runs create [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id TEXT`: Simulation Dataset ID [required] +* `-e, --expansion-set TEXT`: Expansion Set ID [required] +* `--help`: Show this message and exit. + +### `aerie-cli expansion runs list` + +List expansion runs for a given plan or simulation dataset + +Runs are listed in reverse chronological order. + +**Usage**: + +```console +$ aerie-cli expansion runs list [OPTIONS] +``` + +**Options**: + +* `-p, --plan-id TEXT`: Plan ID +* `-s, --sim-id TEXT`: Simulation Dataset ID +* `--help`: Show this message and exit. + +## `aerie-cli expansion sequences` + +Commands for sequences + +**Usage**: + +```console +$ aerie-cli expansion sequences [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `create`: Create a sequence on a simulation dataset +* `delete`: Delete sequence on a simulation dataset +* `download`: Download a SeqJson file from an Aerie... +* `list`: List sequences for a given plan or... + +### `aerie-cli expansion sequences create` + +Create a sequence on a simulation dataset + +**Usage**: + +```console +$ aerie-cli expansion sequences create [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id TEXT`: Simulation Dataset ID [required] +* `-t, --sequence-id TEXT`: Sequence ID to download [required] +* `--help`: Show this message and exit. + +### `aerie-cli expansion sequences delete` + +Delete sequence on a simulation dataset + +**Usage**: + +```console +$ aerie-cli expansion sequences delete [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id TEXT`: Simulation Dataset ID [required] +* `-t, --sequence-id TEXT`: Sequence ID to download [required] +* `--help`: Show this message and exit. + +### `aerie-cli expansion sequences download` + +Download a SeqJson file from an Aerie sequence + +**Usage**: + +```console +$ aerie-cli expansion sequences download [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id TEXT`: Simulation Dataset ID [required] +* `-t, --sequence-id TEXT`: Sequence ID to download [required] +* `-o, --output TEXT`: Name of output JSON file [required] +* `--help`: Show this message and exit. + +### `aerie-cli expansion sequences list` + +List sequences for a given plan or simulation dataset + +Sequences are listed in alphabetical order. + +**Usage**: + +```console +$ aerie-cli expansion sequences list [OPTIONS] +``` + +**Options**: + +* `-p, --plan-id TEXT`: Plan ID +* `-s, --sim-id TEXT`: Simulation Dataset ID +* `--help`: Show this message and exit. + +## `aerie-cli expansion sets` + +Commands for expansion sets + +**Usage**: + +```console +$ aerie-cli expansion sets [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `create`: Create an expansion set +* `get`: View all rules in an expansion set +* `list`: List all expansion sets + +### `aerie-cli expansion sets create` + +Create an expansion set + +Uses the newest expansion rules for each given activity type. +Filters to only use rules designated for the given mission model and +command dictionary. + +**Usage**: + +```console +$ aerie-cli expansion sets create [OPTIONS] +``` + +**Options**: + +* `-m, --model-id INTEGER`: Mission Model ID [required] +* `-d, --command-dict-id INTEGER`: Command Dictionary ID [required] +* `-a, --activity-types TEXT`: Activity types to be included in the set +* `--help`: Show this message and exit. + +### `aerie-cli expansion sets get` + +View all rules in an expansion set + +**Usage**: + +```console +$ aerie-cli expansion sets get [OPTIONS] +``` + +**Options**: + +* `-e, --expansion-set TEXT`: Expansion Set ID [required] +* `--help`: Show this message and exit. + +### `aerie-cli expansion sets list` + +List all expansion sets + +**Usage**: + +```console +$ aerie-cli expansion sets list [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. diff --git a/cli_docs/generate_cli_docs.py b/cli_docs/generate_cli_docs.py new file mode 100644 index 00000000..3696596f --- /dev/null +++ b/cli_docs/generate_cli_docs.py @@ -0,0 +1,25 @@ +""" +Generates docs for CLI command files to Markdown files in /cli_docs folder +""" + +import subprocess +import os +import sys +import typer + +path_to_commands = "../src/aerie_cli/commands" + +for filename in os.listdir(path_to_commands): + total_filepath = os.path.join(path_to_commands, filename) + if os.path.isfile(total_filepath): + input_name = filename[:-3] + + #skip command_context.py for now + if(filename != 'command_context.py'): + try: + #run typer for all files that uses typer's '@app.command' + subprocess.run(['typer', total_filepath, 'utils', 'docs', + "--name", 'aerie-cli ' + input_name , + "--output", input_name + '.md']) + except subprocess.CalledProcessError as e: + print(f"Subprocess failed for {filename}: {e}") diff --git a/cli_docs/metadata.md b/cli_docs/metadata.md new file mode 100644 index 00000000..f6e1568c --- /dev/null +++ b/cli_docs/metadata.md @@ -0,0 +1,80 @@ +# `aerie-cli metadata` + +**Usage**: + +```console +$ aerie-cli metadata [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--install-completion`: Install completion for the current shell. +* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. +* `--help`: Show this message and exit. + +**Commands**: + +* `clean`: Delete all metadata schemas. +* `delete`: Delete a metadata schema by its name. +* `list`: List uploaded metadata schemas. +* `upload`: Add to the metadata schema from a .json file. + +## `aerie-cli metadata clean` + +Delete all metadata schemas. + +**Usage**: + +```console +$ aerie-cli metadata clean [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +## `aerie-cli metadata delete` + +Delete a metadata schema by its name. + +**Usage**: + +```console +$ aerie-cli metadata delete [OPTIONS] +``` + +**Options**: + +* `-n, --schema-name TEXT`: Name of schema to be deleted [required] +* `--help`: Show this message and exit. + +## `aerie-cli metadata list` + +List uploaded metadata schemas. + +**Usage**: + +```console +$ aerie-cli metadata list [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +## `aerie-cli metadata upload` + +Add to the metadata schema from a .json file. + +JSON file contents should include a list schemas, each containing a key for its name and value for its type. + +**Usage**: + +```console +$ aerie-cli metadata upload [OPTIONS] +``` + +**Options**: + +* `-i, --schema-path TEXT`: path to JSON file defining the schema to be created [required] +* `--help`: Show this message and exit. diff --git a/cli_docs/models.md b/cli_docs/models.md new file mode 100644 index 00000000..68a6f859 --- /dev/null +++ b/cli_docs/models.md @@ -0,0 +1,82 @@ +# `aerie-cli models` + +**Usage**: + +```console +$ aerie-cli models [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--install-completion`: Install completion for the current shell. +* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. +* `--help`: Show this message and exit. + +**Commands**: + +* `clean`: Delete all mission models. +* `delete`: Delete a mission model by its model id. +* `list`: List uploaded mission models. +* `upload`: Upload a single mission model from a .jar... + +## `aerie-cli models clean` + +Delete all mission models. + +**Usage**: + +```console +$ aerie-cli models clean [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +## `aerie-cli models delete` + +Delete a mission model by its model id. + +**Usage**: + +```console +$ aerie-cli models delete [OPTIONS] +``` + +**Options**: + +* `-m, --model-id INTEGER`: Mission model ID to be deleted [required] +* `--help`: Show this message and exit. + +## `aerie-cli models list` + +List uploaded mission models. + +**Usage**: + +```console +$ aerie-cli models list [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +## `aerie-cli models upload` + +Upload a single mission model from a .jar file. + +**Usage**: + +```console +$ aerie-cli models upload [OPTIONS] +``` + +**Options**: + +* `-i, --mission-model-path TEXT`: The input file from which to create an Aerie model [required] +* `-n, --model-name TEXT`: Name of mission model [required] +* `-v, --version TEXT`: Mission model verison +* `--time-tag-version`: Use timestamp for model version +* `--sim-template TEXT`: Simulation template file +* `--help`: Show this message and exit. diff --git a/cli_docs/plans.md b/cli_docs/plans.md new file mode 100644 index 00000000..4c68a4de --- /dev/null +++ b/cli_docs/plans.md @@ -0,0 +1,210 @@ +# `aerie-cli plans` + +**Usage**: + +```console +$ aerie-cli plans [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--install-completion`: Install completion for the current shell. +* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. +* `--help`: Show this message and exit. + +**Commands**: + +* `clean`: Delete all activity plans. +* `create-config`: Clean and Create New Configuration for a... +* `delete`: Delete an activity plan by its id. +* `download`: Download a plan and save it locally as a... +* `download-resources`: Download resource timelines from a... +* `download-simulation`: Download simulated activity instances and... +* `duplicate`: Duplicate an existing plan. +* `list`: List uploaded plans. +* `simulate`: Simulate a plan and optionally download... +* `update-config`: Update Configuration for a Given Plan. +* `upload`: Create a plan from an input JSON file. + +## `aerie-cli plans clean` + +Delete all activity plans. + +**Usage**: + +```console +$ aerie-cli plans clean [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +## `aerie-cli plans create-config` + +Clean and Create New Configuration for a Given Plan. + +**Usage**: + +```console +$ aerie-cli plans create-config [OPTIONS] +``` + +**Options**: + +* `--plan-id INTEGER`: Plan ID [required] +* `--arg-file TEXT`: JSON file with configuration arguments [required] +* `--help`: Show this message and exit. + +## `aerie-cli plans delete` + +Delete an activity plan by its id. + +**Usage**: + +```console +$ aerie-cli plans delete [OPTIONS] +``` + +**Options**: + +* `-p, --plan-id INTEGER`: Plan ID to be deleted [required] +* `--help`: Show this message and exit. + +## `aerie-cli plans download` + +Download a plan and save it locally as a JSON file. + +**Usage**: + +```console +$ aerie-cli plans download [OPTIONS] +``` + +**Options**: + +* `-p, --plan-id, --id INTEGER`: Plan ID [required] +* `--full-args TEXT`: true, false, or comma separated list of activity types for which to get full arguments. Otherwise only modified arguments are returned. Defaults to false. +* `-o, --output TEXT`: The output file destination [required] +* `--help`: Show this message and exit. + +## `aerie-cli plans download-resources` + +Download resource timelines from a simulation and save to either JSON or CSV. + +JSON resource timelines are formatted as lists of time-value pairs. Relative timestamps are milliseconds since +plan start time. Absolute timestamps are of the form YYYY-DDDTh:mm:ss.sss + +CSV resource timeline relative timestamps are seconds since plan start time. Absolute timestamps are formatted the +same as the JSON outputs. + +**Usage**: + +```console +$ aerie-cli plans download-resources [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id INTEGER`: Simulation Dataset ID [required] +* `--csv / --json`: Specify file format. Defaults to JSON [default: json] +* `-o, --output TEXT`: The output file destination [required] +* `--absolute-time`: Change relative timestamps to absolute +* `--specific-states TEXT`: The file with the specific states [defaults to all] +* `--help`: Show this message and exit. + +## `aerie-cli plans download-simulation` + +Download simulated activity instances and save to a JSON file + +**Usage**: + +```console +$ aerie-cli plans download-simulation [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id INTEGER`: Simulation Dataset ID [required] +* `-o, --output TEXT`: The output file destination [required] +* `--help`: Show this message and exit. + +## `aerie-cli plans duplicate` + +Duplicate an existing plan. + +**Usage**: + +```console +$ aerie-cli plans duplicate [OPTIONS] +``` + +**Options**: + +* `-p, --plan-id, --id INTEGER`: Plan ID [required] +* `-n, --duplicate-plan-name TEXT`: The name for the duplicated plan [required] +* `--help`: Show this message and exit. + +## `aerie-cli plans list` + +List uploaded plans. + +**Usage**: + +```console +$ aerie-cli plans list [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +## `aerie-cli plans simulate` + +Simulate a plan and optionally download the results. + +**Usage**: + +```console +$ aerie-cli plans simulate [OPTIONS] +``` + +**Options**: + +* `--id INTEGER`: Plan ID [required] +* `-o, --output TEXT`: The output file destination for simulation results (if desired) +* `--poll-period INTEGER`: The period (seconds) at which to poll for simulation completion [default: 5] +* `--help`: Show this message and exit. + +## `aerie-cli plans update-config` + +Update Configuration for a Given Plan. + +**Usage**: + +```console +$ aerie-cli plans update-config [OPTIONS] +``` + +**Options**: + +* `--plan-id INTEGER`: Plan ID [required] +* `--arg-file TEXT`: JSON file with configuration arguments [required] +* `--help`: Show this message and exit. + +## `aerie-cli plans upload` + +Create a plan from an input JSON file. + +**Usage**: + +```console +$ aerie-cli plans upload [OPTIONS] +``` + +**Options**: + +* `-i, --input TEXT`: The input file from which to create an Aerie plan [required] +* `-m, --model-id INTEGER`: The mission model ID to associate with the plan [required] +* `--time-tag / --no-time-tag`: Append time tag to plan name [default: no-time-tag] +* `--help`: Show this message and exit. diff --git a/cli_docs/scheduling.md b/cli_docs/scheduling.md new file mode 100644 index 00000000..58fcf716 --- /dev/null +++ b/cli_docs/scheduling.md @@ -0,0 +1,64 @@ +# `aerie-cli scheduling` + +**Usage**: + +```console +$ aerie-cli scheduling [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--install-completion`: Install completion for the current shell. +* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. +* `--help`: Show this message and exit. + +**Commands**: + +* `delete`: Delete scheduling goal +* `delete-all-goals-for-plan` +* `upload`: Upload scheduling goal + +## `aerie-cli scheduling delete` + +Delete scheduling goal + +**Usage**: + +```console +$ aerie-cli scheduling delete [OPTIONS] +``` + +**Options**: + +* `--goal-id INTEGER`: Goal ID of goal to be deleted [required] +* `--help`: Show this message and exit. + +## `aerie-cli scheduling delete-all-goals-for-plan` + +**Usage**: + +```console +$ aerie-cli scheduling delete-all-goals-for-plan [OPTIONS] +``` + +**Options**: + +* `--plan-id INTEGER`: Plan ID [required] +* `--help`: Show this message and exit. + +## `aerie-cli scheduling upload` + +Upload scheduling goal + +**Usage**: + +```console +$ aerie-cli scheduling upload [OPTIONS] +``` + +**Options**: + +* `--model-id INTEGER`: The mission model ID to associate with the scheduling goal [required] +* `--plan-id INTEGER`: Plan ID [required] +* `--schedule TEXT`: Text file with one path on each line to a scheduling rule file, in decreasing priority order [required] +* `--help`: Show this message and exit. From adf2952b5013eca91e63dd446b1d00f90d1f664d Mon Sep 17 00:00:00 2001 From: zgoldberg22 Date: Thu, 14 Sep 2023 16:10:07 -0400 Subject: [PATCH 2/8] modified .gitignore for sphinx-api doc autogenerated files --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index d4f86078..5a85cc25 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,6 @@ __pycache__/ args.json temp.json **/*.DS_Store +api_docs/build/ +api_docs/make.bat +api_docs/Makefile From 02a7b86f17ea4321335ad105a3e118f843c69eb9 Mon Sep 17 00:00:00 2001 From: zgoldberg22 Date: Thu, 14 Sep 2023 16:14:57 -0400 Subject: [PATCH 3/8] rst files and conf.py file to create api-docs with sphinx --- api_docs/source/aerie_cli.rst | 46 +++++++++++++++++++++++++++ api_docs/source/aerie_cli.schemas.rst | 21 ++++++++++++ api_docs/source/aerie_cli.utils.rst | 37 +++++++++++++++++++++ api_docs/source/conf.py | 32 +++++++++++++++++++ api_docs/source/index.rst | 10 ++++++ 5 files changed, 146 insertions(+) create mode 100644 api_docs/source/aerie_cli.rst create mode 100644 api_docs/source/aerie_cli.schemas.rst create mode 100644 api_docs/source/aerie_cli.utils.rst create mode 100644 api_docs/source/conf.py create mode 100644 api_docs/source/index.rst diff --git a/api_docs/source/aerie_cli.rst b/api_docs/source/aerie_cli.rst new file mode 100644 index 00000000..6c053890 --- /dev/null +++ b/api_docs/source/aerie_cli.rst @@ -0,0 +1,46 @@ +aerie\_cli package +================== + +.. Submodules +.. ---------- + +aerie\_cli.aerie\_client module +------------------------------- + +.. automodule:: aerie_cli.aerie_client + :members: + :undoc-members: + :show-inheritance: + +aerie\_cli.aerie\_host module +----------------------------- + +.. automodule:: aerie_cli.aerie_host + :members: + :undoc-members: + :show-inheritance: + +aerie\_cli.persistent module +---------------------------- + +.. automodule:: aerie_cli.persistent + :members: + :undoc-members: + :show-inheritance: + +aerie\_cli.app module +---------------------------- + +.. automodule:: aerie_cli.app + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + aerie_cli.schemas + aerie_cli.utils \ No newline at end of file diff --git a/api_docs/source/aerie_cli.schemas.rst b/api_docs/source/aerie_cli.schemas.rst new file mode 100644 index 00000000..f1d3ab7f --- /dev/null +++ b/api_docs/source/aerie_cli.schemas.rst @@ -0,0 +1,21 @@ +aerie\_cli.schemas package +========================== + +.. Submodules +.. ---------- + +aerie\_cli.schemas.api module +----------------------------- + +.. automodule:: aerie_cli.schemas.api + :members: + :undoc-members: + :show-inheritance: + +aerie\_cli.schemas.client module +-------------------------------- + +.. automodule:: aerie_cli.schemas.client + :members: + :undoc-members: + :show-inheritance: diff --git a/api_docs/source/aerie_cli.utils.rst b/api_docs/source/aerie_cli.utils.rst new file mode 100644 index 00000000..5dd4e9a8 --- /dev/null +++ b/api_docs/source/aerie_cli.utils.rst @@ -0,0 +1,37 @@ +aerie\_cli.utils package +======================== + +.. Submodules +.. ---------- + +aerie\_cli.utils.configurations module +-------------------------------------- + +.. automodule:: aerie_cli.utils.configurations + :members: + :undoc-members: + :show-inheritance: + +aerie\_cli.utils.prompts module +------------------------------- + +.. automodule:: aerie_cli.utils.prompts + :members: + :undoc-members: + :show-inheritance: + +aerie\_cli.utils.serialization module +------------------------------------- + +.. automodule:: aerie_cli.utils.serialization + :members: + :undoc-members: + :show-inheritance: + +aerie\_cli.utils.sessions module +-------------------------------- + +.. automodule:: aerie_cli.utils.sessions + :members: + :undoc-members: + :show-inheritance: diff --git a/api_docs/source/conf.py b/api_docs/source/conf.py new file mode 100644 index 00000000..2691b51d --- /dev/null +++ b/api_docs/source/conf.py @@ -0,0 +1,32 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Aerie-CLI-API-Docs' +copyright = '2023, zoe' +author = 'zoe' +release = '0.1' + +import os +import sys +sys.path.insert(0, os.path.abspath('../..')) + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon', "sphinx.ext.doctest"] + +templates_path = ['_templates'] +exclude_patterns = [] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'furo' +html_static_path = ['_static'] diff --git a/api_docs/source/index.rst b/api_docs/source/index.rst new file mode 100644 index 00000000..db94e133 --- /dev/null +++ b/api_docs/source/index.rst @@ -0,0 +1,10 @@ +Aerie CLI API's documentation! +============================================== + +.. toctree:: + :maxdepth: 5 + :caption: Contents: + + aerie_cli + aerie_cli.schemas + aerie_cli.utils From 2762c091324d6b69a84e4f6f0420056f84201a96 Mon Sep 17 00:00:00 2001 From: zgoldberg22 Date: Fri, 15 Sep 2023 10:57:59 -0400 Subject: [PATCH 4/8] added app.py to cli_docs --- cli_docs/README.md | 1 + cli_docs/app.md | 979 ++++++++++++++++++++++++++++++++++ cli_docs/generate_cli_docs.py | 12 + 3 files changed, 992 insertions(+) create mode 100644 cli_docs/app.md diff --git a/cli_docs/README.md b/cli_docs/README.md index 954ca9a8..e3718ab2 100644 --- a/cli_docs/README.md +++ b/cli_docs/README.md @@ -2,6 +2,7 @@ ## **CLI Commands**: +- [`app`](app.md) - [`configurations`](configurations.md) - [`constraints`](constraints.md) - [`expansion`](expansion.md) diff --git a/cli_docs/app.md b/cli_docs/app.md new file mode 100644 index 00000000..b7626755 --- /dev/null +++ b/cli_docs/app.md @@ -0,0 +1,979 @@ +# `aerie-cli app` + +**Usage**: + +```console +$ aerie-cli app [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `-v, --version`: Print Aerie-CLI package version and exit. +* `--hasura-admin-secret TEXT`: Hasura admin secret that will be put in the header of graphql requests. +* `--install-completion`: Install completion for the current shell. +* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. +* `--help`: Show this message and exit. + +**Commands**: + +* `activate`: Activate a session with an Aerie host... +* `configurations` +* `constraints` +* `deactivate`: Deactivate any active session +* `expansion` +* `metadata` +* `models` +* `plans` +* `role`: Change Aerie permissions role for the... +* `scheduling` +* `status`: Returns information about the current... + +## `aerie-cli app activate` + +Activate a session with an Aerie host using a given configuration + +**Usage**: + +```console +$ aerie-cli app activate [OPTIONS] +``` + +**Options**: + +* `-n, --name NAME`: Name for this configuration +* `-r, --role ROLE`: Specify a non-default role +* `--help`: Show this message and exit. + +## `aerie-cli app configurations` + +**Usage**: + +```console +$ aerie-cli app configurations [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `activate`: Activate a session with an Aerie host... +* `clean`: Remove all persistent aerie-cli files +* `create`: Define a configuration for an Aerie host +* `deactivate`: Deactivate any active session +* `delete`: Delete an Aerie host configuration +* `list`: List available Aerie host configurations +* `load`: Load one or more configurations from a... +* `update`: Update an existing configuration for an... + +### `aerie-cli app configurations activate` + +Activate a session with an Aerie host using a given configuration + +**Usage**: + +```console +$ aerie-cli app configurations activate [OPTIONS] +``` + +**Options**: + +* `-n, --name NAME`: Name for this configuration +* `--help`: Show this message and exit. + +### `aerie-cli app configurations clean` + +Remove all persistent aerie-cli files + +**Usage**: + +```console +$ aerie-cli app configurations clean [OPTIONS] +``` + +**Options**: + +* `--not-interactive / --no-not-interactive`: Disable interactive prompt [default: no-not-interactive] +* `--help`: Show this message and exit. + +### `aerie-cli app configurations create` + +Define a configuration for an Aerie host + +**Usage**: + +```console +$ aerie-cli app configurations create [OPTIONS] +``` + +**Options**: + +* `--name NAME`: Name for this configuration [required] +* `--graphql-url GRAPHQL_URL`: URL of GraphQL API endpoint [required] +* `--gateway-url GATEWAY_URL`: URL of Aerie Gateway [required] +* `--auth-method [None|Native|Cookie]`: Authentication method [default: None] +* `--auth-url AUTH_URL`: URL of Authentication endpoint +* `--username USERNAME`: Username for authentication +* `--help`: Show this message and exit. + +### `aerie-cli app configurations deactivate` + +Deactivate any active session + +**Usage**: + +```console +$ aerie-cli app configurations deactivate [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +### `aerie-cli app configurations delete` + +Delete an Aerie host configuration + +**Usage**: + +```console +$ aerie-cli app configurations delete [OPTIONS] +``` + +**Options**: + +* `-n, --name NAME`: Name for this configuration +* `--help`: Show this message and exit. + +### `aerie-cli app configurations list` + +List available Aerie host configurations + +**Usage**: + +```console +$ aerie-cli app configurations list [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +### `aerie-cli app configurations load` + +Load one or more configurations from a JSON file + +**Usage**: + +```console +$ aerie-cli app configurations load [OPTIONS] +``` + +**Options**: + +* `-i, --filename PATH`: Name of input JSON file [required] +* `--allow-overwrite`: Allow overwriting existing configurations +* `--help`: Show this message and exit. + +### `aerie-cli app configurations update` + +Update an existing configuration for an Aerie host + +**Usage**: + +```console +$ aerie-cli app configurations update [OPTIONS] +``` + +**Options**: + +* `-n, --name NAME`: Name of the configuration to update +* `--help`: Show this message and exit. + +## `aerie-cli app constraints` + +**Usage**: + +```console +$ aerie-cli app constraints [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `delete`: Delete a constraint +* `update`: Update a constraint +* `upload`: Upload a constraint +* `violations` + +### `aerie-cli app constraints delete` + +Delete a constraint + +**Usage**: + +```console +$ aerie-cli app constraints delete [OPTIONS] +``` + +**Options**: + +* `--id INTEGER`: The constraint id to be deleted [required] +* `--help`: Show this message and exit. + +### `aerie-cli app constraints update` + +Update a constraint + +**Usage**: + +```console +$ aerie-cli app constraints update [OPTIONS] +``` + +**Options**: + +* `--id INTEGER`: The constraint id to be modifyed [required] +* `--constraint-file TEXT`: The new constraint for the id [required] +* `--help`: Show this message and exit. + +### `aerie-cli app constraints upload` + +Upload a constraint + +**Usage**: + +```console +$ aerie-cli app constraints upload [OPTIONS] +``` + +**Options**: + +* `--model-id INTEGER`: The model id associated with the constraint (do not input plan id) +* `--plan-id INTEGER`: The plan id associated with the constraint (do not input model id) +* `--name TEXT`: The name of the constraint [required] +* `--summary TEXT`: The summary of the constraint +* `--description TEXT`: The description of the constraint +* `--constraint-file TEXT`: The file that holds the constraint [required] +* `--help`: Show this message and exit. + +### `aerie-cli app constraints violations` + +**Usage**: + +```console +$ aerie-cli app constraints violations [OPTIONS] +``` + +**Options**: + +* `--plan-id INTEGER`: The plan id for the violation [required] +* `--help`: Show this message and exit. + +## `aerie-cli app deactivate` + +Deactivate any active session + +**Usage**: + +```console +$ aerie-cli app deactivate [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +## `aerie-cli app expansion` + +**Usage**: + +```console +$ aerie-cli app expansion [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `runs`: Commands for expansion runs +* `sequences`: Commands for sequences +* `sets`: Commands for expansion sets + +### `aerie-cli app expansion runs` + +Commands for expansion runs + +**Usage**: + +```console +$ aerie-cli app expansion runs [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `create`: Run command expansion on a simulation dataset +* `list`: List expansion runs for a given plan or... + +#### `aerie-cli app expansion runs create` + +Run command expansion on a simulation dataset + +**Usage**: + +```console +$ aerie-cli app expansion runs create [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id TEXT`: Simulation Dataset ID [required] +* `-e, --expansion-set TEXT`: Expansion Set ID [required] +* `--help`: Show this message and exit. + +#### `aerie-cli app expansion runs list` + +List expansion runs for a given plan or simulation dataset + +Runs are listed in reverse chronological order. + +**Usage**: + +```console +$ aerie-cli app expansion runs list [OPTIONS] +``` + +**Options**: + +* `-p, --plan-id TEXT`: Plan ID +* `-s, --sim-id TEXT`: Simulation Dataset ID +* `--help`: Show this message and exit. + +### `aerie-cli app expansion sequences` + +Commands for sequences + +**Usage**: + +```console +$ aerie-cli app expansion sequences [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `create`: Create a sequence on a simulation dataset +* `delete`: Delete sequence on a simulation dataset +* `download`: Download a SeqJson file from an Aerie... +* `list`: List sequences for a given plan or... + +#### `aerie-cli app expansion sequences create` + +Create a sequence on a simulation dataset + +**Usage**: + +```console +$ aerie-cli app expansion sequences create [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id TEXT`: Simulation Dataset ID [required] +* `-t, --sequence-id TEXT`: Sequence ID to download [required] +* `--help`: Show this message and exit. + +#### `aerie-cli app expansion sequences delete` + +Delete sequence on a simulation dataset + +**Usage**: + +```console +$ aerie-cli app expansion sequences delete [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id TEXT`: Simulation Dataset ID [required] +* `-t, --sequence-id TEXT`: Sequence ID to download [required] +* `--help`: Show this message and exit. + +#### `aerie-cli app expansion sequences download` + +Download a SeqJson file from an Aerie sequence + +**Usage**: + +```console +$ aerie-cli app expansion sequences download [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id TEXT`: Simulation Dataset ID [required] +* `-t, --sequence-id TEXT`: Sequence ID to download [required] +* `-o, --output TEXT`: Name of output JSON file [required] +* `--help`: Show this message and exit. + +#### `aerie-cli app expansion sequences list` + +List sequences for a given plan or simulation dataset + +Sequences are listed in alphabetical order. + +**Usage**: + +```console +$ aerie-cli app expansion sequences list [OPTIONS] +``` + +**Options**: + +* `-p, --plan-id TEXT`: Plan ID +* `-s, --sim-id TEXT`: Simulation Dataset ID +* `--help`: Show this message and exit. + +### `aerie-cli app expansion sets` + +Commands for expansion sets + +**Usage**: + +```console +$ aerie-cli app expansion sets [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `create`: Create an expansion set +* `get`: View all rules in an expansion set +* `list`: List all expansion sets + +#### `aerie-cli app expansion sets create` + +Create an expansion set + +Uses the newest expansion rules for each given activity type. +Filters to only use rules designated for the given mission model and +command dictionary. + +**Usage**: + +```console +$ aerie-cli app expansion sets create [OPTIONS] +``` + +**Options**: + +* `-m, --model-id INTEGER`: Mission Model ID [required] +* `-d, --command-dict-id INTEGER`: Command Dictionary ID [required] +* `-a, --activity-types TEXT`: Activity types to be included in the set +* `--help`: Show this message and exit. + +#### `aerie-cli app expansion sets get` + +View all rules in an expansion set + +**Usage**: + +```console +$ aerie-cli app expansion sets get [OPTIONS] +``` + +**Options**: + +* `-e, --expansion-set TEXT`: Expansion Set ID [required] +* `--help`: Show this message and exit. + +#### `aerie-cli app expansion sets list` + +List all expansion sets + +**Usage**: + +```console +$ aerie-cli app expansion sets list [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +## `aerie-cli app metadata` + +**Usage**: + +```console +$ aerie-cli app metadata [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `clean`: Delete all metadata schemas. +* `delete`: Delete a metadata schema by its name. +* `list`: List uploaded metadata schemas. +* `upload`: Add to the metadata schema from a .json file. + +### `aerie-cli app metadata clean` + +Delete all metadata schemas. + +**Usage**: + +```console +$ aerie-cli app metadata clean [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +### `aerie-cli app metadata delete` + +Delete a metadata schema by its name. + +**Usage**: + +```console +$ aerie-cli app metadata delete [OPTIONS] +``` + +**Options**: + +* `-n, --schema-name TEXT`: Name of schema to be deleted [required] +* `--help`: Show this message and exit. + +### `aerie-cli app metadata list` + +List uploaded metadata schemas. + +**Usage**: + +```console +$ aerie-cli app metadata list [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +### `aerie-cli app metadata upload` + +Add to the metadata schema from a .json file. + +JSON file contents should include a list schemas, each containing a key for its name and value for its type. + +**Usage**: + +```console +$ aerie-cli app metadata upload [OPTIONS] +``` + +**Options**: + +* `-i, --schema-path TEXT`: path to JSON file defining the schema to be created [required] +* `--help`: Show this message and exit. + +## `aerie-cli app models` + +**Usage**: + +```console +$ aerie-cli app models [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `clean`: Delete all mission models. +* `delete`: Delete a mission model by its model id. +* `list`: List uploaded mission models. +* `upload`: Upload a single mission model from a .jar... + +### `aerie-cli app models clean` + +Delete all mission models. + +**Usage**: + +```console +$ aerie-cli app models clean [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +### `aerie-cli app models delete` + +Delete a mission model by its model id. + +**Usage**: + +```console +$ aerie-cli app models delete [OPTIONS] +``` + +**Options**: + +* `-m, --model-id INTEGER`: Mission model ID to be deleted [required] +* `--help`: Show this message and exit. + +### `aerie-cli app models list` + +List uploaded mission models. + +**Usage**: + +```console +$ aerie-cli app models list [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +### `aerie-cli app models upload` + +Upload a single mission model from a .jar file. + +**Usage**: + +```console +$ aerie-cli app models upload [OPTIONS] +``` + +**Options**: + +* `-i, --mission-model-path TEXT`: The input file from which to create an Aerie model [required] +* `-n, --model-name TEXT`: Name of mission model [required] +* `-v, --version TEXT`: Mission model verison +* `--time-tag-version`: Use timestamp for model version +* `--sim-template TEXT`: Simulation template file +* `--help`: Show this message and exit. + +## `aerie-cli app plans` + +**Usage**: + +```console +$ aerie-cli app plans [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `clean`: Delete all activity plans. +* `create-config`: Clean and Create New Configuration for a... +* `delete`: Delete an activity plan by its id. +* `download`: Download a plan and save it locally as a... +* `download-resources`: Download resource timelines from a... +* `download-simulation`: Download simulated activity instances and... +* `duplicate`: Duplicate an existing plan. +* `list`: List uploaded plans. +* `simulate`: Simulate a plan and optionally download... +* `update-config`: Update Configuration for a Given Plan. +* `upload`: Create a plan from an input JSON file. + +### `aerie-cli app plans clean` + +Delete all activity plans. + +**Usage**: + +```console +$ aerie-cli app plans clean [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +### `aerie-cli app plans create-config` + +Clean and Create New Configuration for a Given Plan. + +**Usage**: + +```console +$ aerie-cli app plans create-config [OPTIONS] +``` + +**Options**: + +* `--plan-id INTEGER`: Plan ID [required] +* `--arg-file TEXT`: JSON file with configuration arguments [required] +* `--help`: Show this message and exit. + +### `aerie-cli app plans delete` + +Delete an activity plan by its id. + +**Usage**: + +```console +$ aerie-cli app plans delete [OPTIONS] +``` + +**Options**: + +* `-p, --plan-id INTEGER`: Plan ID to be deleted [required] +* `--help`: Show this message and exit. + +### `aerie-cli app plans download` + +Download a plan and save it locally as a JSON file. + +**Usage**: + +```console +$ aerie-cli app plans download [OPTIONS] +``` + +**Options**: + +* `-p, --plan-id, --id INTEGER`: Plan ID [required] +* `--full-args TEXT`: true, false, or comma separated list of activity types for which to get full arguments. Otherwise only modified arguments are returned. Defaults to false. +* `-o, --output TEXT`: The output file destination [required] +* `--help`: Show this message and exit. + +### `aerie-cli app plans download-resources` + +Download resource timelines from a simulation and save to either JSON or CSV. + +JSON resource timelines are formatted as lists of time-value pairs. Relative timestamps are milliseconds since +plan start time. Absolute timestamps are of the form YYYY-DDDTh:mm:ss.sss + +CSV resource timeline relative timestamps are seconds since plan start time. Absolute timestamps are formatted the +same as the JSON outputs. + +**Usage**: + +```console +$ aerie-cli app plans download-resources [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id INTEGER`: Simulation Dataset ID [required] +* `--csv / --json`: Specify file format. Defaults to JSON [default: json] +* `-o, --output TEXT`: The output file destination [required] +* `--absolute-time`: Change relative timestamps to absolute +* `--specific-states TEXT`: The file with the specific states [defaults to all] +* `--help`: Show this message and exit. + +### `aerie-cli app plans download-simulation` + +Download simulated activity instances and save to a JSON file + +**Usage**: + +```console +$ aerie-cli app plans download-simulation [OPTIONS] +``` + +**Options**: + +* `-s, --sim-id INTEGER`: Simulation Dataset ID [required] +* `-o, --output TEXT`: The output file destination [required] +* `--help`: Show this message and exit. + +### `aerie-cli app plans duplicate` + +Duplicate an existing plan. + +**Usage**: + +```console +$ aerie-cli app plans duplicate [OPTIONS] +``` + +**Options**: + +* `-p, --plan-id, --id INTEGER`: Plan ID [required] +* `-n, --duplicate-plan-name TEXT`: The name for the duplicated plan [required] +* `--help`: Show this message and exit. + +### `aerie-cli app plans list` + +List uploaded plans. + +**Usage**: + +```console +$ aerie-cli app plans list [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. + +### `aerie-cli app plans simulate` + +Simulate a plan and optionally download the results. + +**Usage**: + +```console +$ aerie-cli app plans simulate [OPTIONS] +``` + +**Options**: + +* `--id INTEGER`: Plan ID [required] +* `-o, --output TEXT`: The output file destination for simulation results (if desired) +* `--poll-period INTEGER`: The period (seconds) at which to poll for simulation completion [default: 5] +* `--help`: Show this message and exit. + +### `aerie-cli app plans update-config` + +Update Configuration for a Given Plan. + +**Usage**: + +```console +$ aerie-cli app plans update-config [OPTIONS] +``` + +**Options**: + +* `--plan-id INTEGER`: Plan ID [required] +* `--arg-file TEXT`: JSON file with configuration arguments [required] +* `--help`: Show this message and exit. + +### `aerie-cli app plans upload` + +Create a plan from an input JSON file. + +**Usage**: + +```console +$ aerie-cli app plans upload [OPTIONS] +``` + +**Options**: + +* `-i, --input TEXT`: The input file from which to create an Aerie plan [required] +* `-m, --model-id INTEGER`: The mission model ID to associate with the plan [required] +* `--time-tag / --no-time-tag`: Append time tag to plan name [default: no-time-tag] +* `--help`: Show this message and exit. + +## `aerie-cli app role` + +Change Aerie permissions role for the active session + +**Usage**: + +```console +$ aerie-cli app role [OPTIONS] +``` + +**Options**: + +* `-r, --role ROLE`: New role to selec +* `--help`: Show this message and exit. + +## `aerie-cli app scheduling` + +**Usage**: + +```console +$ aerie-cli app scheduling [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +* `--help`: Show this message and exit. + +**Commands**: + +* `delete`: Delete scheduling goal +* `delete-all-goals-for-plan` +* `upload`: Upload scheduling goal to single plan or... + +### `aerie-cli app scheduling delete` + +Delete scheduling goal + +**Usage**: + +```console +$ aerie-cli app scheduling delete [OPTIONS] +``` + +**Options**: + +* `--goal-id INTEGER`: Goal ID of goal to be deleted [required] +* `--help`: Show this message and exit. + +### `aerie-cli app scheduling delete-all-goals-for-plan` + +**Usage**: + +```console +$ aerie-cli app scheduling delete-all-goals-for-plan [OPTIONS] +``` + +**Options**: + +* `--plan-id INTEGER`: Plan ID [required] +* `--help`: Show this message and exit. + +### `aerie-cli app scheduling upload` + +Upload scheduling goal to single plan or to all plans in a model + +**Usage**: + +```console +$ aerie-cli app scheduling upload [OPTIONS] +``` + +**Options**: + +* `-m, --model-id INTEGER`: The mission model ID to associate with the scheduling goal +* `-p, --plan-id INTEGER`: Plan ID +* `-f, --file-path TEXT`: Text file with one path on each line to a scheduling rule file, in decreasing priority order +* `--help`: Show this message and exit. + +## `aerie-cli app status` + +Returns information about the current Aerie session. + +**Usage**: + +```console +$ aerie-cli app status [OPTIONS] +``` + +**Options**: + +* `--help`: Show this message and exit. diff --git a/cli_docs/generate_cli_docs.py b/cli_docs/generate_cli_docs.py index 3696596f..dd8ccc6a 100644 --- a/cli_docs/generate_cli_docs.py +++ b/cli_docs/generate_cli_docs.py @@ -9,6 +9,7 @@ path_to_commands = "../src/aerie_cli/commands" +#app commands from /commands directory for filename in os.listdir(path_to_commands): total_filepath = os.path.join(path_to_commands, filename) if os.path.isfile(total_filepath): @@ -23,3 +24,14 @@ "--output", input_name + '.md']) except subprocess.CalledProcessError as e: print(f"Subprocess failed for {filename}: {e}") + +#generate docs for app.py +path_to_app = "../src/aerie_cli/app.py" + +try: + #run typer for all files that uses typer's '@app.command' + subprocess.run(['typer', path_to_app, 'utils', 'docs', + "--name", 'aerie-cli app' , + "--output", 'app.md']) +except subprocess.CalledProcessError as e: + print(f"Subprocess failed for {filename}: {e}") \ No newline at end of file From 150c38c73147b1bf461e5cca6d530077f6905fea Mon Sep 17 00:00:00 2001 From: zgoldberg22 Date: Fri, 15 Sep 2023 11:33:52 -0400 Subject: [PATCH 5/8] add README for api_docs and remove app.py from sphinx docs --- api_docs/README.md | 43 +++++++++++++++++++++++++++++++++++ api_docs/source/aerie_cli.rst | 8 ------- 2 files changed, 43 insertions(+), 8 deletions(-) create mode 100644 api_docs/README.md diff --git a/api_docs/README.md b/api_docs/README.md new file mode 100644 index 00000000..8def9053 --- /dev/null +++ b/api_docs/README.md @@ -0,0 +1,43 @@ +# **Auto-documentation for Aerie-CLI API:** + +The Aerie-CLI API provides a user-extendable API for interacting with an instance of Aerie. + +The following steps generate documentation for the files in `src/aerie_cli` (excluding the `/command` directory and `app.py`). + +
+ +## **How to Generate Documentation Using Sphinx-CLI** +1. Make sure you have `sphinx` is installed: + + ``` + pip install sphinx + ``` + +2. Navigate to the outer `aerie-cli` directory: + ``` + cd aerie-cli + ``` + +3. Using [`sphinx-apidoc`](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html), generate the for files in `src/aerie_cli` into the `api_docs` directory. + ``` + sphinx-apidoc -o ./api_docs/source ./src/aerie_cli + ``` + +4. View this documentation with the `index.html` file located in `api_docs/build/html`. + +
+ +## **Modify the Documentation Output** +To edit the format of the html output, you can modify the following files using the directives from the sphinx `autodoc` extension ([`sphinx.ext.autodoc`](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html)): + +1. [`aerie_cli.rst`](source/aerie_cli.rst): Contains files in the src/aerie_cli directory (excluding app.py). Lists subpackages as aerie_cli.schemas and aerie_cli.utils. +2. [`aerie_cli.schemas.rst`](source/aerie_cli.schemas.rst): Contains the files in the src/aerie_cli/schemas directory. +3. [`aerie_cli.utils.rst`](source/aerie_cli.schemas.rst): Contains the files in the src/aerie_cli/utils directory. + +
+ +## **Format Docstrings** +Sphinx autodoc can correctly generate docs from two formatting options: + +1. Follow the [Google Style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). Many of the docstrings already in the app follow this style. +2. Or, an alternative is following the [Sphinx Docstring format](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html). diff --git a/api_docs/source/aerie_cli.rst b/api_docs/source/aerie_cli.rst index 6c053890..de3e52ab 100644 --- a/api_docs/source/aerie_cli.rst +++ b/api_docs/source/aerie_cli.rst @@ -28,14 +28,6 @@ aerie\_cli.persistent module :undoc-members: :show-inheritance: -aerie\_cli.app module ----------------------------- - -.. automodule:: aerie_cli.app - :members: - :undoc-members: - :show-inheritance: - Subpackages ----------- From 345fdb39f19a0c9cc5ae35be057c9845170a512d Mon Sep 17 00:00:00 2001 From: zgoldberg22 Date: Fri, 20 Oct 2023 10:09:01 -0400 Subject: [PATCH 6/8] changed app.py docs to aerie-cli without app --- cli_docs/generate_cli_docs.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cli_docs/generate_cli_docs.py b/cli_docs/generate_cli_docs.py index dd8ccc6a..9dada9a8 100644 --- a/cli_docs/generate_cli_docs.py +++ b/cli_docs/generate_cli_docs.py @@ -31,7 +31,7 @@ try: #run typer for all files that uses typer's '@app.command' subprocess.run(['typer', path_to_app, 'utils', 'docs', - "--name", 'aerie-cli app' , + "--name", 'aerie-cli' , "--output", 'app.md']) except subprocess.CalledProcessError as e: print(f"Subprocess failed for {filename}: {e}") \ No newline at end of file From 7ca53f7e55d140f3ae4983af02c4d218d9563196 Mon Sep 17 00:00:00 2001 From: zgoldberg22 Date: Wed, 25 Oct 2023 11:04:27 -0400 Subject: [PATCH 7/8] create generated files for cli docs, changes to gitignore --- .gitignore | 3 +++ cli_docs/generate_cli_docs.py | 9 +++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 5a85cc25..8d15dbc7 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,6 @@ temp.json api_docs/build/ api_docs/make.bat api_docs/Makefile +cli_docs/* +!cli_docs/generate_cli_docs.py +!cli_docs/README.MD \ No newline at end of file diff --git a/cli_docs/generate_cli_docs.py b/cli_docs/generate_cli_docs.py index 9dada9a8..ab7869f9 100644 --- a/cli_docs/generate_cli_docs.py +++ b/cli_docs/generate_cli_docs.py @@ -1,5 +1,6 @@ """ Generates docs for CLI command files to Markdown files in /cli_docs folder + ** Note - run while in `cli_docs/` directory so files generate in correct spot """ import subprocess @@ -17,11 +18,14 @@ #skip command_context.py for now if(filename != 'command_context.py'): + #create a new file if doesn't exist + output_file = open(input_name + ".md", "w") + try: #run typer for all files that uses typer's '@app.command' subprocess.run(['typer', total_filepath, 'utils', 'docs', "--name", 'aerie-cli ' + input_name , - "--output", input_name + '.md']) + "--output", input_name + ".md"]) except subprocess.CalledProcessError as e: print(f"Subprocess failed for {filename}: {e}") @@ -29,9 +33,10 @@ path_to_app = "../src/aerie_cli/app.py" try: + output_file = open("app.md", "w") #run typer for all files that uses typer's '@app.command' subprocess.run(['typer', path_to_app, 'utils', 'docs', "--name", 'aerie-cli' , - "--output", 'app.md']) + "--output", "app.md"]) except subprocess.CalledProcessError as e: print(f"Subprocess failed for {filename}: {e}") \ No newline at end of file From 07a99118d380c6b6fee8bf2e129ecbf8472072dc Mon Sep 17 00:00:00 2001 From: zgoldberg22 Date: Wed, 25 Oct 2023 11:05:45 -0400 Subject: [PATCH 8/8] .gitignore now ignoring correct cli docs files --- cli_docs/app.md | 979 ------------------------------------- cli_docs/configurations.md | 99 ---- cli_docs/constraints.md | 83 ---- cli_docs/expansion.md | 230 --------- cli_docs/metadata.md | 80 --- cli_docs/models.md | 82 ---- cli_docs/plans.md | 210 -------- cli_docs/scheduling.md | 64 --- 8 files changed, 1827 deletions(-) delete mode 100644 cli_docs/app.md delete mode 100644 cli_docs/configurations.md delete mode 100644 cli_docs/constraints.md delete mode 100644 cli_docs/expansion.md delete mode 100644 cli_docs/metadata.md delete mode 100644 cli_docs/models.md delete mode 100644 cli_docs/plans.md delete mode 100644 cli_docs/scheduling.md diff --git a/cli_docs/app.md b/cli_docs/app.md deleted file mode 100644 index b7626755..00000000 --- a/cli_docs/app.md +++ /dev/null @@ -1,979 +0,0 @@ -# `aerie-cli app` - -**Usage**: - -```console -$ aerie-cli app [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `-v, --version`: Print Aerie-CLI package version and exit. -* `--hasura-admin-secret TEXT`: Hasura admin secret that will be put in the header of graphql requests. -* `--install-completion`: Install completion for the current shell. -* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. -* `--help`: Show this message and exit. - -**Commands**: - -* `activate`: Activate a session with an Aerie host... -* `configurations` -* `constraints` -* `deactivate`: Deactivate any active session -* `expansion` -* `metadata` -* `models` -* `plans` -* `role`: Change Aerie permissions role for the... -* `scheduling` -* `status`: Returns information about the current... - -## `aerie-cli app activate` - -Activate a session with an Aerie host using a given configuration - -**Usage**: - -```console -$ aerie-cli app activate [OPTIONS] -``` - -**Options**: - -* `-n, --name NAME`: Name for this configuration -* `-r, --role ROLE`: Specify a non-default role -* `--help`: Show this message and exit. - -## `aerie-cli app configurations` - -**Usage**: - -```console -$ aerie-cli app configurations [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `activate`: Activate a session with an Aerie host... -* `clean`: Remove all persistent aerie-cli files -* `create`: Define a configuration for an Aerie host -* `deactivate`: Deactivate any active session -* `delete`: Delete an Aerie host configuration -* `list`: List available Aerie host configurations -* `load`: Load one or more configurations from a... -* `update`: Update an existing configuration for an... - -### `aerie-cli app configurations activate` - -Activate a session with an Aerie host using a given configuration - -**Usage**: - -```console -$ aerie-cli app configurations activate [OPTIONS] -``` - -**Options**: - -* `-n, --name NAME`: Name for this configuration -* `--help`: Show this message and exit. - -### `aerie-cli app configurations clean` - -Remove all persistent aerie-cli files - -**Usage**: - -```console -$ aerie-cli app configurations clean [OPTIONS] -``` - -**Options**: - -* `--not-interactive / --no-not-interactive`: Disable interactive prompt [default: no-not-interactive] -* `--help`: Show this message and exit. - -### `aerie-cli app configurations create` - -Define a configuration for an Aerie host - -**Usage**: - -```console -$ aerie-cli app configurations create [OPTIONS] -``` - -**Options**: - -* `--name NAME`: Name for this configuration [required] -* `--graphql-url GRAPHQL_URL`: URL of GraphQL API endpoint [required] -* `--gateway-url GATEWAY_URL`: URL of Aerie Gateway [required] -* `--auth-method [None|Native|Cookie]`: Authentication method [default: None] -* `--auth-url AUTH_URL`: URL of Authentication endpoint -* `--username USERNAME`: Username for authentication -* `--help`: Show this message and exit. - -### `aerie-cli app configurations deactivate` - -Deactivate any active session - -**Usage**: - -```console -$ aerie-cli app configurations deactivate [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -### `aerie-cli app configurations delete` - -Delete an Aerie host configuration - -**Usage**: - -```console -$ aerie-cli app configurations delete [OPTIONS] -``` - -**Options**: - -* `-n, --name NAME`: Name for this configuration -* `--help`: Show this message and exit. - -### `aerie-cli app configurations list` - -List available Aerie host configurations - -**Usage**: - -```console -$ aerie-cli app configurations list [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -### `aerie-cli app configurations load` - -Load one or more configurations from a JSON file - -**Usage**: - -```console -$ aerie-cli app configurations load [OPTIONS] -``` - -**Options**: - -* `-i, --filename PATH`: Name of input JSON file [required] -* `--allow-overwrite`: Allow overwriting existing configurations -* `--help`: Show this message and exit. - -### `aerie-cli app configurations update` - -Update an existing configuration for an Aerie host - -**Usage**: - -```console -$ aerie-cli app configurations update [OPTIONS] -``` - -**Options**: - -* `-n, --name NAME`: Name of the configuration to update -* `--help`: Show this message and exit. - -## `aerie-cli app constraints` - -**Usage**: - -```console -$ aerie-cli app constraints [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `delete`: Delete a constraint -* `update`: Update a constraint -* `upload`: Upload a constraint -* `violations` - -### `aerie-cli app constraints delete` - -Delete a constraint - -**Usage**: - -```console -$ aerie-cli app constraints delete [OPTIONS] -``` - -**Options**: - -* `--id INTEGER`: The constraint id to be deleted [required] -* `--help`: Show this message and exit. - -### `aerie-cli app constraints update` - -Update a constraint - -**Usage**: - -```console -$ aerie-cli app constraints update [OPTIONS] -``` - -**Options**: - -* `--id INTEGER`: The constraint id to be modifyed [required] -* `--constraint-file TEXT`: The new constraint for the id [required] -* `--help`: Show this message and exit. - -### `aerie-cli app constraints upload` - -Upload a constraint - -**Usage**: - -```console -$ aerie-cli app constraints upload [OPTIONS] -``` - -**Options**: - -* `--model-id INTEGER`: The model id associated with the constraint (do not input plan id) -* `--plan-id INTEGER`: The plan id associated with the constraint (do not input model id) -* `--name TEXT`: The name of the constraint [required] -* `--summary TEXT`: The summary of the constraint -* `--description TEXT`: The description of the constraint -* `--constraint-file TEXT`: The file that holds the constraint [required] -* `--help`: Show this message and exit. - -### `aerie-cli app constraints violations` - -**Usage**: - -```console -$ aerie-cli app constraints violations [OPTIONS] -``` - -**Options**: - -* `--plan-id INTEGER`: The plan id for the violation [required] -* `--help`: Show this message and exit. - -## `aerie-cli app deactivate` - -Deactivate any active session - -**Usage**: - -```console -$ aerie-cli app deactivate [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -## `aerie-cli app expansion` - -**Usage**: - -```console -$ aerie-cli app expansion [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `runs`: Commands for expansion runs -* `sequences`: Commands for sequences -* `sets`: Commands for expansion sets - -### `aerie-cli app expansion runs` - -Commands for expansion runs - -**Usage**: - -```console -$ aerie-cli app expansion runs [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `create`: Run command expansion on a simulation dataset -* `list`: List expansion runs for a given plan or... - -#### `aerie-cli app expansion runs create` - -Run command expansion on a simulation dataset - -**Usage**: - -```console -$ aerie-cli app expansion runs create [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id TEXT`: Simulation Dataset ID [required] -* `-e, --expansion-set TEXT`: Expansion Set ID [required] -* `--help`: Show this message and exit. - -#### `aerie-cli app expansion runs list` - -List expansion runs for a given plan or simulation dataset - -Runs are listed in reverse chronological order. - -**Usage**: - -```console -$ aerie-cli app expansion runs list [OPTIONS] -``` - -**Options**: - -* `-p, --plan-id TEXT`: Plan ID -* `-s, --sim-id TEXT`: Simulation Dataset ID -* `--help`: Show this message and exit. - -### `aerie-cli app expansion sequences` - -Commands for sequences - -**Usage**: - -```console -$ aerie-cli app expansion sequences [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `create`: Create a sequence on a simulation dataset -* `delete`: Delete sequence on a simulation dataset -* `download`: Download a SeqJson file from an Aerie... -* `list`: List sequences for a given plan or... - -#### `aerie-cli app expansion sequences create` - -Create a sequence on a simulation dataset - -**Usage**: - -```console -$ aerie-cli app expansion sequences create [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id TEXT`: Simulation Dataset ID [required] -* `-t, --sequence-id TEXT`: Sequence ID to download [required] -* `--help`: Show this message and exit. - -#### `aerie-cli app expansion sequences delete` - -Delete sequence on a simulation dataset - -**Usage**: - -```console -$ aerie-cli app expansion sequences delete [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id TEXT`: Simulation Dataset ID [required] -* `-t, --sequence-id TEXT`: Sequence ID to download [required] -* `--help`: Show this message and exit. - -#### `aerie-cli app expansion sequences download` - -Download a SeqJson file from an Aerie sequence - -**Usage**: - -```console -$ aerie-cli app expansion sequences download [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id TEXT`: Simulation Dataset ID [required] -* `-t, --sequence-id TEXT`: Sequence ID to download [required] -* `-o, --output TEXT`: Name of output JSON file [required] -* `--help`: Show this message and exit. - -#### `aerie-cli app expansion sequences list` - -List sequences for a given plan or simulation dataset - -Sequences are listed in alphabetical order. - -**Usage**: - -```console -$ aerie-cli app expansion sequences list [OPTIONS] -``` - -**Options**: - -* `-p, --plan-id TEXT`: Plan ID -* `-s, --sim-id TEXT`: Simulation Dataset ID -* `--help`: Show this message and exit. - -### `aerie-cli app expansion sets` - -Commands for expansion sets - -**Usage**: - -```console -$ aerie-cli app expansion sets [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `create`: Create an expansion set -* `get`: View all rules in an expansion set -* `list`: List all expansion sets - -#### `aerie-cli app expansion sets create` - -Create an expansion set - -Uses the newest expansion rules for each given activity type. -Filters to only use rules designated for the given mission model and -command dictionary. - -**Usage**: - -```console -$ aerie-cli app expansion sets create [OPTIONS] -``` - -**Options**: - -* `-m, --model-id INTEGER`: Mission Model ID [required] -* `-d, --command-dict-id INTEGER`: Command Dictionary ID [required] -* `-a, --activity-types TEXT`: Activity types to be included in the set -* `--help`: Show this message and exit. - -#### `aerie-cli app expansion sets get` - -View all rules in an expansion set - -**Usage**: - -```console -$ aerie-cli app expansion sets get [OPTIONS] -``` - -**Options**: - -* `-e, --expansion-set TEXT`: Expansion Set ID [required] -* `--help`: Show this message and exit. - -#### `aerie-cli app expansion sets list` - -List all expansion sets - -**Usage**: - -```console -$ aerie-cli app expansion sets list [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -## `aerie-cli app metadata` - -**Usage**: - -```console -$ aerie-cli app metadata [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `clean`: Delete all metadata schemas. -* `delete`: Delete a metadata schema by its name. -* `list`: List uploaded metadata schemas. -* `upload`: Add to the metadata schema from a .json file. - -### `aerie-cli app metadata clean` - -Delete all metadata schemas. - -**Usage**: - -```console -$ aerie-cli app metadata clean [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -### `aerie-cli app metadata delete` - -Delete a metadata schema by its name. - -**Usage**: - -```console -$ aerie-cli app metadata delete [OPTIONS] -``` - -**Options**: - -* `-n, --schema-name TEXT`: Name of schema to be deleted [required] -* `--help`: Show this message and exit. - -### `aerie-cli app metadata list` - -List uploaded metadata schemas. - -**Usage**: - -```console -$ aerie-cli app metadata list [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -### `aerie-cli app metadata upload` - -Add to the metadata schema from a .json file. - -JSON file contents should include a list schemas, each containing a key for its name and value for its type. - -**Usage**: - -```console -$ aerie-cli app metadata upload [OPTIONS] -``` - -**Options**: - -* `-i, --schema-path TEXT`: path to JSON file defining the schema to be created [required] -* `--help`: Show this message and exit. - -## `aerie-cli app models` - -**Usage**: - -```console -$ aerie-cli app models [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `clean`: Delete all mission models. -* `delete`: Delete a mission model by its model id. -* `list`: List uploaded mission models. -* `upload`: Upload a single mission model from a .jar... - -### `aerie-cli app models clean` - -Delete all mission models. - -**Usage**: - -```console -$ aerie-cli app models clean [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -### `aerie-cli app models delete` - -Delete a mission model by its model id. - -**Usage**: - -```console -$ aerie-cli app models delete [OPTIONS] -``` - -**Options**: - -* `-m, --model-id INTEGER`: Mission model ID to be deleted [required] -* `--help`: Show this message and exit. - -### `aerie-cli app models list` - -List uploaded mission models. - -**Usage**: - -```console -$ aerie-cli app models list [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -### `aerie-cli app models upload` - -Upload a single mission model from a .jar file. - -**Usage**: - -```console -$ aerie-cli app models upload [OPTIONS] -``` - -**Options**: - -* `-i, --mission-model-path TEXT`: The input file from which to create an Aerie model [required] -* `-n, --model-name TEXT`: Name of mission model [required] -* `-v, --version TEXT`: Mission model verison -* `--time-tag-version`: Use timestamp for model version -* `--sim-template TEXT`: Simulation template file -* `--help`: Show this message and exit. - -## `aerie-cli app plans` - -**Usage**: - -```console -$ aerie-cli app plans [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `clean`: Delete all activity plans. -* `create-config`: Clean and Create New Configuration for a... -* `delete`: Delete an activity plan by its id. -* `download`: Download a plan and save it locally as a... -* `download-resources`: Download resource timelines from a... -* `download-simulation`: Download simulated activity instances and... -* `duplicate`: Duplicate an existing plan. -* `list`: List uploaded plans. -* `simulate`: Simulate a plan and optionally download... -* `update-config`: Update Configuration for a Given Plan. -* `upload`: Create a plan from an input JSON file. - -### `aerie-cli app plans clean` - -Delete all activity plans. - -**Usage**: - -```console -$ aerie-cli app plans clean [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -### `aerie-cli app plans create-config` - -Clean and Create New Configuration for a Given Plan. - -**Usage**: - -```console -$ aerie-cli app plans create-config [OPTIONS] -``` - -**Options**: - -* `--plan-id INTEGER`: Plan ID [required] -* `--arg-file TEXT`: JSON file with configuration arguments [required] -* `--help`: Show this message and exit. - -### `aerie-cli app plans delete` - -Delete an activity plan by its id. - -**Usage**: - -```console -$ aerie-cli app plans delete [OPTIONS] -``` - -**Options**: - -* `-p, --plan-id INTEGER`: Plan ID to be deleted [required] -* `--help`: Show this message and exit. - -### `aerie-cli app plans download` - -Download a plan and save it locally as a JSON file. - -**Usage**: - -```console -$ aerie-cli app plans download [OPTIONS] -``` - -**Options**: - -* `-p, --plan-id, --id INTEGER`: Plan ID [required] -* `--full-args TEXT`: true, false, or comma separated list of activity types for which to get full arguments. Otherwise only modified arguments are returned. Defaults to false. -* `-o, --output TEXT`: The output file destination [required] -* `--help`: Show this message and exit. - -### `aerie-cli app plans download-resources` - -Download resource timelines from a simulation and save to either JSON or CSV. - -JSON resource timelines are formatted as lists of time-value pairs. Relative timestamps are milliseconds since -plan start time. Absolute timestamps are of the form YYYY-DDDTh:mm:ss.sss - -CSV resource timeline relative timestamps are seconds since plan start time. Absolute timestamps are formatted the -same as the JSON outputs. - -**Usage**: - -```console -$ aerie-cli app plans download-resources [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id INTEGER`: Simulation Dataset ID [required] -* `--csv / --json`: Specify file format. Defaults to JSON [default: json] -* `-o, --output TEXT`: The output file destination [required] -* `--absolute-time`: Change relative timestamps to absolute -* `--specific-states TEXT`: The file with the specific states [defaults to all] -* `--help`: Show this message and exit. - -### `aerie-cli app plans download-simulation` - -Download simulated activity instances and save to a JSON file - -**Usage**: - -```console -$ aerie-cli app plans download-simulation [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id INTEGER`: Simulation Dataset ID [required] -* `-o, --output TEXT`: The output file destination [required] -* `--help`: Show this message and exit. - -### `aerie-cli app plans duplicate` - -Duplicate an existing plan. - -**Usage**: - -```console -$ aerie-cli app plans duplicate [OPTIONS] -``` - -**Options**: - -* `-p, --plan-id, --id INTEGER`: Plan ID [required] -* `-n, --duplicate-plan-name TEXT`: The name for the duplicated plan [required] -* `--help`: Show this message and exit. - -### `aerie-cli app plans list` - -List uploaded plans. - -**Usage**: - -```console -$ aerie-cli app plans list [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -### `aerie-cli app plans simulate` - -Simulate a plan and optionally download the results. - -**Usage**: - -```console -$ aerie-cli app plans simulate [OPTIONS] -``` - -**Options**: - -* `--id INTEGER`: Plan ID [required] -* `-o, --output TEXT`: The output file destination for simulation results (if desired) -* `--poll-period INTEGER`: The period (seconds) at which to poll for simulation completion [default: 5] -* `--help`: Show this message and exit. - -### `aerie-cli app plans update-config` - -Update Configuration for a Given Plan. - -**Usage**: - -```console -$ aerie-cli app plans update-config [OPTIONS] -``` - -**Options**: - -* `--plan-id INTEGER`: Plan ID [required] -* `--arg-file TEXT`: JSON file with configuration arguments [required] -* `--help`: Show this message and exit. - -### `aerie-cli app plans upload` - -Create a plan from an input JSON file. - -**Usage**: - -```console -$ aerie-cli app plans upload [OPTIONS] -``` - -**Options**: - -* `-i, --input TEXT`: The input file from which to create an Aerie plan [required] -* `-m, --model-id INTEGER`: The mission model ID to associate with the plan [required] -* `--time-tag / --no-time-tag`: Append time tag to plan name [default: no-time-tag] -* `--help`: Show this message and exit. - -## `aerie-cli app role` - -Change Aerie permissions role for the active session - -**Usage**: - -```console -$ aerie-cli app role [OPTIONS] -``` - -**Options**: - -* `-r, --role ROLE`: New role to selec -* `--help`: Show this message and exit. - -## `aerie-cli app scheduling` - -**Usage**: - -```console -$ aerie-cli app scheduling [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `delete`: Delete scheduling goal -* `delete-all-goals-for-plan` -* `upload`: Upload scheduling goal to single plan or... - -### `aerie-cli app scheduling delete` - -Delete scheduling goal - -**Usage**: - -```console -$ aerie-cli app scheduling delete [OPTIONS] -``` - -**Options**: - -* `--goal-id INTEGER`: Goal ID of goal to be deleted [required] -* `--help`: Show this message and exit. - -### `aerie-cli app scheduling delete-all-goals-for-plan` - -**Usage**: - -```console -$ aerie-cli app scheduling delete-all-goals-for-plan [OPTIONS] -``` - -**Options**: - -* `--plan-id INTEGER`: Plan ID [required] -* `--help`: Show this message and exit. - -### `aerie-cli app scheduling upload` - -Upload scheduling goal to single plan or to all plans in a model - -**Usage**: - -```console -$ aerie-cli app scheduling upload [OPTIONS] -``` - -**Options**: - -* `-m, --model-id INTEGER`: The mission model ID to associate with the scheduling goal -* `-p, --plan-id INTEGER`: Plan ID -* `-f, --file-path TEXT`: Text file with one path on each line to a scheduling rule file, in decreasing priority order -* `--help`: Show this message and exit. - -## `aerie-cli app status` - -Returns information about the current Aerie session. - -**Usage**: - -```console -$ aerie-cli app status [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. diff --git a/cli_docs/configurations.md b/cli_docs/configurations.md deleted file mode 100644 index f666153b..00000000 --- a/cli_docs/configurations.md +++ /dev/null @@ -1,99 +0,0 @@ -# `aerie-cli configurations` - -**Usage**: - -```console -$ aerie-cli configurations [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--install-completion`: Install completion for the current shell. -* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. -* `--help`: Show this message and exit. - -**Commands**: - -* `clean`: Remove all persistent aerie-cli files -* `create`: Define a configuration for an Aerie host -* `delete`: Delete an Aerie host configuration -* `list`: List available Aerie host configurations -* `load`: Load one or more configurations from a... - -## `aerie-cli configurations clean` - -Remove all persistent aerie-cli files - -**Usage**: - -```console -$ aerie-cli configurations clean [OPTIONS] -``` - -**Options**: - -* `--not-interactive / --no-not-interactive`: Disable interactive prompt [default: no-not-interactive] -* `--help`: Show this message and exit. - -## `aerie-cli configurations create` - -Define a configuration for an Aerie host - -**Usage**: - -```console -$ aerie-cli configurations create [OPTIONS] -``` - -**Options**: - -* `--name NAME`: Name for this configuration [required] -* `--graphql-url GRAPHQL_URL`: URL of GraphQL API endpoint [required] -* `--gateway-url GATEWAY_URL`: URL of Aerie Gateway [required] -* `--username USERNAME`: Username for authentication -* `--help`: Show this message and exit. - -## `aerie-cli configurations delete` - -Delete an Aerie host configuration - -**Usage**: - -```console -$ aerie-cli configurations delete [OPTIONS] -``` - -**Options**: - -* `-n, --name NAME`: Name for this configuration -* `--help`: Show this message and exit. - -## `aerie-cli configurations list` - -List available Aerie host configurations - -**Usage**: - -```console -$ aerie-cli configurations list [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -## `aerie-cli configurations load` - -Load one or more configurations from a JSON file - -**Usage**: - -```console -$ aerie-cli configurations load [OPTIONS] -``` - -**Options**: - -* `-i, --filename PATH`: Name of input JSON file [required] -* `--allow-overwrite`: Allow overwriting existing configurations -* `--help`: Show this message and exit. diff --git a/cli_docs/constraints.md b/cli_docs/constraints.md deleted file mode 100644 index 4a07452a..00000000 --- a/cli_docs/constraints.md +++ /dev/null @@ -1,83 +0,0 @@ -# `aerie-cli constraints` - -**Usage**: - -```console -$ aerie-cli constraints [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--install-completion`: Install completion for the current shell. -* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. -* `--help`: Show this message and exit. - -**Commands**: - -* `delete`: Delete a constraint -* `update`: Update a constraint -* `upload`: Upload a constraint -* `violations` - -## `aerie-cli constraints delete` - -Delete a constraint - -**Usage**: - -```console -$ aerie-cli constraints delete [OPTIONS] -``` - -**Options**: - -* `--id INTEGER`: The constraint id to be deleted [required] -* `--help`: Show this message and exit. - -## `aerie-cli constraints update` - -Update a constraint - -**Usage**: - -```console -$ aerie-cli constraints update [OPTIONS] -``` - -**Options**: - -* `--id INTEGER`: The constraint id to be modifyed [required] -* `--constraint-file TEXT`: The new constraint for the id [required] -* `--help`: Show this message and exit. - -## `aerie-cli constraints upload` - -Upload a constraint - -**Usage**: - -```console -$ aerie-cli constraints upload [OPTIONS] -``` - -**Options**: - -* `--model-id INTEGER`: The model id associated with the constraint (do not input plan id) -* `--plan-id INTEGER`: The plan id associated with the constraint (do not input model id) -* `--name TEXT`: The name of the constraint [required] -* `--description TEXT`: The description of the constraint -* `--constraint-file TEXT`: The file that holds the constraint [required] -* `--help`: Show this message and exit. - -## `aerie-cli constraints violations` - -**Usage**: - -```console -$ aerie-cli constraints violations [OPTIONS] -``` - -**Options**: - -* `--plan-id INTEGER`: The plan id for the violation [required] -* `--help`: Show this message and exit. diff --git a/cli_docs/expansion.md b/cli_docs/expansion.md deleted file mode 100644 index 4f2d7443..00000000 --- a/cli_docs/expansion.md +++ /dev/null @@ -1,230 +0,0 @@ -# `aerie-cli expansion` - -**Usage**: - -```console -$ aerie-cli expansion [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--install-completion`: Install completion for the current shell. -* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. -* `--help`: Show this message and exit. - -**Commands**: - -* `runs`: Commands for expansion runs -* `sequences`: Commands for sequences -* `sets`: Commands for expansion sets - -## `aerie-cli expansion runs` - -Commands for expansion runs - -**Usage**: - -```console -$ aerie-cli expansion runs [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `create`: Run command expansion on a simulation dataset -* `list`: List expansion runs for a given plan or... - -### `aerie-cli expansion runs create` - -Run command expansion on a simulation dataset - -**Usage**: - -```console -$ aerie-cli expansion runs create [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id TEXT`: Simulation Dataset ID [required] -* `-e, --expansion-set TEXT`: Expansion Set ID [required] -* `--help`: Show this message and exit. - -### `aerie-cli expansion runs list` - -List expansion runs for a given plan or simulation dataset - -Runs are listed in reverse chronological order. - -**Usage**: - -```console -$ aerie-cli expansion runs list [OPTIONS] -``` - -**Options**: - -* `-p, --plan-id TEXT`: Plan ID -* `-s, --sim-id TEXT`: Simulation Dataset ID -* `--help`: Show this message and exit. - -## `aerie-cli expansion sequences` - -Commands for sequences - -**Usage**: - -```console -$ aerie-cli expansion sequences [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `create`: Create a sequence on a simulation dataset -* `delete`: Delete sequence on a simulation dataset -* `download`: Download a SeqJson file from an Aerie... -* `list`: List sequences for a given plan or... - -### `aerie-cli expansion sequences create` - -Create a sequence on a simulation dataset - -**Usage**: - -```console -$ aerie-cli expansion sequences create [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id TEXT`: Simulation Dataset ID [required] -* `-t, --sequence-id TEXT`: Sequence ID to download [required] -* `--help`: Show this message and exit. - -### `aerie-cli expansion sequences delete` - -Delete sequence on a simulation dataset - -**Usage**: - -```console -$ aerie-cli expansion sequences delete [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id TEXT`: Simulation Dataset ID [required] -* `-t, --sequence-id TEXT`: Sequence ID to download [required] -* `--help`: Show this message and exit. - -### `aerie-cli expansion sequences download` - -Download a SeqJson file from an Aerie sequence - -**Usage**: - -```console -$ aerie-cli expansion sequences download [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id TEXT`: Simulation Dataset ID [required] -* `-t, --sequence-id TEXT`: Sequence ID to download [required] -* `-o, --output TEXT`: Name of output JSON file [required] -* `--help`: Show this message and exit. - -### `aerie-cli expansion sequences list` - -List sequences for a given plan or simulation dataset - -Sequences are listed in alphabetical order. - -**Usage**: - -```console -$ aerie-cli expansion sequences list [OPTIONS] -``` - -**Options**: - -* `-p, --plan-id TEXT`: Plan ID -* `-s, --sim-id TEXT`: Simulation Dataset ID -* `--help`: Show this message and exit. - -## `aerie-cli expansion sets` - -Commands for expansion sets - -**Usage**: - -```console -$ aerie-cli expansion sets [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--help`: Show this message and exit. - -**Commands**: - -* `create`: Create an expansion set -* `get`: View all rules in an expansion set -* `list`: List all expansion sets - -### `aerie-cli expansion sets create` - -Create an expansion set - -Uses the newest expansion rules for each given activity type. -Filters to only use rules designated for the given mission model and -command dictionary. - -**Usage**: - -```console -$ aerie-cli expansion sets create [OPTIONS] -``` - -**Options**: - -* `-m, --model-id INTEGER`: Mission Model ID [required] -* `-d, --command-dict-id INTEGER`: Command Dictionary ID [required] -* `-a, --activity-types TEXT`: Activity types to be included in the set -* `--help`: Show this message and exit. - -### `aerie-cli expansion sets get` - -View all rules in an expansion set - -**Usage**: - -```console -$ aerie-cli expansion sets get [OPTIONS] -``` - -**Options**: - -* `-e, --expansion-set TEXT`: Expansion Set ID [required] -* `--help`: Show this message and exit. - -### `aerie-cli expansion sets list` - -List all expansion sets - -**Usage**: - -```console -$ aerie-cli expansion sets list [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. diff --git a/cli_docs/metadata.md b/cli_docs/metadata.md deleted file mode 100644 index f6e1568c..00000000 --- a/cli_docs/metadata.md +++ /dev/null @@ -1,80 +0,0 @@ -# `aerie-cli metadata` - -**Usage**: - -```console -$ aerie-cli metadata [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--install-completion`: Install completion for the current shell. -* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. -* `--help`: Show this message and exit. - -**Commands**: - -* `clean`: Delete all metadata schemas. -* `delete`: Delete a metadata schema by its name. -* `list`: List uploaded metadata schemas. -* `upload`: Add to the metadata schema from a .json file. - -## `aerie-cli metadata clean` - -Delete all metadata schemas. - -**Usage**: - -```console -$ aerie-cli metadata clean [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -## `aerie-cli metadata delete` - -Delete a metadata schema by its name. - -**Usage**: - -```console -$ aerie-cli metadata delete [OPTIONS] -``` - -**Options**: - -* `-n, --schema-name TEXT`: Name of schema to be deleted [required] -* `--help`: Show this message and exit. - -## `aerie-cli metadata list` - -List uploaded metadata schemas. - -**Usage**: - -```console -$ aerie-cli metadata list [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -## `aerie-cli metadata upload` - -Add to the metadata schema from a .json file. - -JSON file contents should include a list schemas, each containing a key for its name and value for its type. - -**Usage**: - -```console -$ aerie-cli metadata upload [OPTIONS] -``` - -**Options**: - -* `-i, --schema-path TEXT`: path to JSON file defining the schema to be created [required] -* `--help`: Show this message and exit. diff --git a/cli_docs/models.md b/cli_docs/models.md deleted file mode 100644 index 68a6f859..00000000 --- a/cli_docs/models.md +++ /dev/null @@ -1,82 +0,0 @@ -# `aerie-cli models` - -**Usage**: - -```console -$ aerie-cli models [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--install-completion`: Install completion for the current shell. -* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. -* `--help`: Show this message and exit. - -**Commands**: - -* `clean`: Delete all mission models. -* `delete`: Delete a mission model by its model id. -* `list`: List uploaded mission models. -* `upload`: Upload a single mission model from a .jar... - -## `aerie-cli models clean` - -Delete all mission models. - -**Usage**: - -```console -$ aerie-cli models clean [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -## `aerie-cli models delete` - -Delete a mission model by its model id. - -**Usage**: - -```console -$ aerie-cli models delete [OPTIONS] -``` - -**Options**: - -* `-m, --model-id INTEGER`: Mission model ID to be deleted [required] -* `--help`: Show this message and exit. - -## `aerie-cli models list` - -List uploaded mission models. - -**Usage**: - -```console -$ aerie-cli models list [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -## `aerie-cli models upload` - -Upload a single mission model from a .jar file. - -**Usage**: - -```console -$ aerie-cli models upload [OPTIONS] -``` - -**Options**: - -* `-i, --mission-model-path TEXT`: The input file from which to create an Aerie model [required] -* `-n, --model-name TEXT`: Name of mission model [required] -* `-v, --version TEXT`: Mission model verison -* `--time-tag-version`: Use timestamp for model version -* `--sim-template TEXT`: Simulation template file -* `--help`: Show this message and exit. diff --git a/cli_docs/plans.md b/cli_docs/plans.md deleted file mode 100644 index 4c68a4de..00000000 --- a/cli_docs/plans.md +++ /dev/null @@ -1,210 +0,0 @@ -# `aerie-cli plans` - -**Usage**: - -```console -$ aerie-cli plans [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--install-completion`: Install completion for the current shell. -* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. -* `--help`: Show this message and exit. - -**Commands**: - -* `clean`: Delete all activity plans. -* `create-config`: Clean and Create New Configuration for a... -* `delete`: Delete an activity plan by its id. -* `download`: Download a plan and save it locally as a... -* `download-resources`: Download resource timelines from a... -* `download-simulation`: Download simulated activity instances and... -* `duplicate`: Duplicate an existing plan. -* `list`: List uploaded plans. -* `simulate`: Simulate a plan and optionally download... -* `update-config`: Update Configuration for a Given Plan. -* `upload`: Create a plan from an input JSON file. - -## `aerie-cli plans clean` - -Delete all activity plans. - -**Usage**: - -```console -$ aerie-cli plans clean [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -## `aerie-cli plans create-config` - -Clean and Create New Configuration for a Given Plan. - -**Usage**: - -```console -$ aerie-cli plans create-config [OPTIONS] -``` - -**Options**: - -* `--plan-id INTEGER`: Plan ID [required] -* `--arg-file TEXT`: JSON file with configuration arguments [required] -* `--help`: Show this message and exit. - -## `aerie-cli plans delete` - -Delete an activity plan by its id. - -**Usage**: - -```console -$ aerie-cli plans delete [OPTIONS] -``` - -**Options**: - -* `-p, --plan-id INTEGER`: Plan ID to be deleted [required] -* `--help`: Show this message and exit. - -## `aerie-cli plans download` - -Download a plan and save it locally as a JSON file. - -**Usage**: - -```console -$ aerie-cli plans download [OPTIONS] -``` - -**Options**: - -* `-p, --plan-id, --id INTEGER`: Plan ID [required] -* `--full-args TEXT`: true, false, or comma separated list of activity types for which to get full arguments. Otherwise only modified arguments are returned. Defaults to false. -* `-o, --output TEXT`: The output file destination [required] -* `--help`: Show this message and exit. - -## `aerie-cli plans download-resources` - -Download resource timelines from a simulation and save to either JSON or CSV. - -JSON resource timelines are formatted as lists of time-value pairs. Relative timestamps are milliseconds since -plan start time. Absolute timestamps are of the form YYYY-DDDTh:mm:ss.sss - -CSV resource timeline relative timestamps are seconds since plan start time. Absolute timestamps are formatted the -same as the JSON outputs. - -**Usage**: - -```console -$ aerie-cli plans download-resources [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id INTEGER`: Simulation Dataset ID [required] -* `--csv / --json`: Specify file format. Defaults to JSON [default: json] -* `-o, --output TEXT`: The output file destination [required] -* `--absolute-time`: Change relative timestamps to absolute -* `--specific-states TEXT`: The file with the specific states [defaults to all] -* `--help`: Show this message and exit. - -## `aerie-cli plans download-simulation` - -Download simulated activity instances and save to a JSON file - -**Usage**: - -```console -$ aerie-cli plans download-simulation [OPTIONS] -``` - -**Options**: - -* `-s, --sim-id INTEGER`: Simulation Dataset ID [required] -* `-o, --output TEXT`: The output file destination [required] -* `--help`: Show this message and exit. - -## `aerie-cli plans duplicate` - -Duplicate an existing plan. - -**Usage**: - -```console -$ aerie-cli plans duplicate [OPTIONS] -``` - -**Options**: - -* `-p, --plan-id, --id INTEGER`: Plan ID [required] -* `-n, --duplicate-plan-name TEXT`: The name for the duplicated plan [required] -* `--help`: Show this message and exit. - -## `aerie-cli plans list` - -List uploaded plans. - -**Usage**: - -```console -$ aerie-cli plans list [OPTIONS] -``` - -**Options**: - -* `--help`: Show this message and exit. - -## `aerie-cli plans simulate` - -Simulate a plan and optionally download the results. - -**Usage**: - -```console -$ aerie-cli plans simulate [OPTIONS] -``` - -**Options**: - -* `--id INTEGER`: Plan ID [required] -* `-o, --output TEXT`: The output file destination for simulation results (if desired) -* `--poll-period INTEGER`: The period (seconds) at which to poll for simulation completion [default: 5] -* `--help`: Show this message and exit. - -## `aerie-cli plans update-config` - -Update Configuration for a Given Plan. - -**Usage**: - -```console -$ aerie-cli plans update-config [OPTIONS] -``` - -**Options**: - -* `--plan-id INTEGER`: Plan ID [required] -* `--arg-file TEXT`: JSON file with configuration arguments [required] -* `--help`: Show this message and exit. - -## `aerie-cli plans upload` - -Create a plan from an input JSON file. - -**Usage**: - -```console -$ aerie-cli plans upload [OPTIONS] -``` - -**Options**: - -* `-i, --input TEXT`: The input file from which to create an Aerie plan [required] -* `-m, --model-id INTEGER`: The mission model ID to associate with the plan [required] -* `--time-tag / --no-time-tag`: Append time tag to plan name [default: no-time-tag] -* `--help`: Show this message and exit. diff --git a/cli_docs/scheduling.md b/cli_docs/scheduling.md deleted file mode 100644 index 58fcf716..00000000 --- a/cli_docs/scheduling.md +++ /dev/null @@ -1,64 +0,0 @@ -# `aerie-cli scheduling` - -**Usage**: - -```console -$ aerie-cli scheduling [OPTIONS] COMMAND [ARGS]... -``` - -**Options**: - -* `--install-completion`: Install completion for the current shell. -* `--show-completion`: Show completion for the current shell, to copy it or customize the installation. -* `--help`: Show this message and exit. - -**Commands**: - -* `delete`: Delete scheduling goal -* `delete-all-goals-for-plan` -* `upload`: Upload scheduling goal - -## `aerie-cli scheduling delete` - -Delete scheduling goal - -**Usage**: - -```console -$ aerie-cli scheduling delete [OPTIONS] -``` - -**Options**: - -* `--goal-id INTEGER`: Goal ID of goal to be deleted [required] -* `--help`: Show this message and exit. - -## `aerie-cli scheduling delete-all-goals-for-plan` - -**Usage**: - -```console -$ aerie-cli scheduling delete-all-goals-for-plan [OPTIONS] -``` - -**Options**: - -* `--plan-id INTEGER`: Plan ID [required] -* `--help`: Show this message and exit. - -## `aerie-cli scheduling upload` - -Upload scheduling goal - -**Usage**: - -```console -$ aerie-cli scheduling upload [OPTIONS] -``` - -**Options**: - -* `--model-id INTEGER`: The mission model ID to associate with the scheduling goal [required] -* `--plan-id INTEGER`: Plan ID [required] -* `--schedule TEXT`: Text file with one path on each line to a scheduling rule file, in decreasing priority order [required] -* `--help`: Show this message and exit.