diff --git a/nbs/00_cli.ipynb b/nbs/00_cli.ipynb index ee0fffe..e4bfe18 100644 --- a/nbs/00_cli.ipynb +++ b/nbs/00_cli.ipynb @@ -321,28 +321,16 @@ "name": "stdout", "output_type": "stream", "text": [ - "usage: plash_login [-h] [--token TOKEN] [--show]\n", + "usage: plash_login [-h] [--token (str)] [--show]\n", "\n", "Authenticate CLI with server and save config\n", "\n", - "opti" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "ons:\n", + "options:\n", " -h, --help show this help message and exit\n", - " --token TOKEN Token to save directly to con" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "fig\n", - " --show Output the current session token (default: False)\n" + " --token (str) Token to save directly to config\n", + " --show Output the current session token (default: False)\n", + "\n", + "plash_cli 0.3.14\n" ] } ], @@ -571,34 +559,15 @@ "name": "stdout", "output_type": "stream", "text": [ - "usage: plash_deploy [-h] [--path PATH] [--name NAME] [--force_data]\n", + "usage: plash_deploy [-h] [--path (path)] [--name (str)] [--force-data]\n", "\n", "options:\n", - " -h, --help show t" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "his help message and exit\n", - " --path PATH Path to project (default: .)\n", - " --name NAME Overrides the" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - " .plash file in project root if provided\n", - " --force_data Overwrite data/ directory during deployment" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - " (default: False)\n" + " -h, --help show this help message and exit\n", + " --path (path) Path to project (default: .)\n", + " --name (str) Overrides the .plash file in project root if provided\n", + " --force-data Overwrite data/ directory during deployment (default: False)\n", + "\n", + "plash_cli 0.3.14\n" ] } ], @@ -648,28 +617,16 @@ "name": "stdout", "output_type": "stream", "text": [ - "usage: plash_view [-h] [--path PATH] [--name NAME]\n", + "usage: plash_view [-h] [--path (path)] [--name (str)]\n", "\n", "Open your app in the browser\n", "\n", "options:\n", - " -h, --h" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "elp show this help message and exit\n", - " --path PATH Path to project directory (default: .)\n", - " --name" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - " NAME Overrides the .plash file in project root if provided\n" + " -h, --help show this help message and exit\n", + " --path (path) Path to project directory (default: .)\n", + " --name (str) Overrides the .plash file in project root if provided\n", + "\n", + "plash_cli 0.3.14\n" ] } ], @@ -731,36 +688,17 @@ "name": "stdout", "output_type": "stream", "text": [ - "usage: plash_delete [-h] [--path PATH] [--name NAME] [--force]\n", + "usage: plash_delete [-h] [--force] [--path (path)] [--name (str)]\n", "\n", "Delete your deployed app\n", "\n", "options:\n", - " " - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - " -h, --help show this help message and exit\n", - " --path PATH Path to project (default: .)\n", - " --name N" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "AME Overrides the .plash file in project root if provided\n", - " --force Skip confirmation prompt (" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "default: False)\n" + " -h, --help show this help message and exit\n", + " --force Skip confirmation prompt (default: False)\n", + " --path (path) Path to project (default: .)\n", + " --name (str) Overrides the .plash file in project root if provided\n", + "\n", + "plash_cli 0.3.14\n" ] } ], @@ -815,26 +753,16 @@ "name": "stdout", "output_type": "stream", "text": [ - "usage: plash_start [-h] [--path PATH] [--name NAME]\n", + "usage: plash_start [-h] [--path (path)] [--name (str)]\n", + "\n", + "Start your deployed app\n", "\n", "options:\n", - " -h, --help show this help message " - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "and exit\n", - " --path PATH Path to project (default: .)\n", - " --name NAME Overrides the .plash file in pro" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "ject root if provided\n" + " -h, --help show this help message and exit\n", + " --path (path) Path to project (default: .)\n", + " --name (str) Overrides the .plash file in project root if provided\n", + "\n", + "plash_cli 0.3.14\n" ] } ], @@ -889,26 +817,16 @@ "name": "stdout", "output_type": "stream", "text": [ - "usage: plash_stop [-h] [--path PATH] [--name NAME]\n", + "usage: plash_stop [-h] [--path (path)] [--name (str)]\n", + "\n", + "Stop your deployed app\n", "\n", "options:\n", - " -h, --help show this help message a" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "nd exit\n", - " --path PATH Path to project (default: .)\n", - " --name NAME Overrides the .plash file in proj" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "ect root if provided\n" + " -h, --help show this help message and exit\n", + " --path (path) Path to project (default: .)\n", + " --name (str) Overrides the .plash file in project root if provided\n", + "\n", + "plash_cli 0.3.14\n" ] } ], @@ -991,35 +909,18 @@ "name": "stdout", "output_type": "stream", "text": [ - "usage: plash_logs [-h] [--path PATH] [--name NAME] [--mode {build,app}] [--tail]\n", + "usage: plash_logs [-h] [--tail] [--path (path)] [--name (str)] [--mode {build,app}]\n", + "\n", + "Get logs for your deployed app\n", "\n", "options:\n", - " -h, --h" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "elp show this help message and exit\n", - " --path PATH Path to project (default: .)\n", - " --" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "name NAME Overrides the .plash file in project root if provided\n", - " --mode {build,app} Choose" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - " between build or app logs (default: build)\n", - " --tail Tail the logs (default: False)\n" + " -h, --help show this help message and exit\n", + " --tail Tail the logs (default: False)\n", + " --path (path) Path to project (default: .)\n", + " --name (str) Overrides the .plash file in project root if provided\n", + " --mode {build,app} Choose between build or app logs (default: build)\n", + "\n", + "plash_cli 0.3.14\n" ] } ], @@ -1133,33 +1034,17 @@ "name": "stdout", "output_type": "stream", "text": [ - "usage: plash_download [-h] [--path PATH] [--name NAME] [--save_path SAVE_PATH]\n", + "usage: plash_download [-h] [--path (path)] [--name (str)] [--save-path (path)]\n", + "\n", + "Download deployed app to save_path.\n", "\n", "options:\n", - " -h, --hel" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "p show this help message and exit\n", - " --path PATH Path to project (default: .)\n" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - " --name NAME Overrides the .plash file in project root if provided\n", - " --save_path SAVE_PA" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "TH Save path (optional) (default: ./download/)\n" + " -h, --help show this help message and exit\n", + " --path (path) Path to project (default: .)\n", + " --name (str) Overrides the .plash file in project root if provided\n", + " --save-path (path) Save path (optional) (default: ./download/)\n", + "\n", + "plash_cli 0.3.14\n" ] } ], @@ -1215,14 +1100,9 @@ "\n", "options:\n", " -h, --help show this help message and exit\n", - " --verbo" - ] - }, - { - "name": "stdout", - "output_type": "stream", - "text": [ - "se Whether to show running status as well as name: 1=running, 0=stopped (default: False)\n" + " --verbose Whether to show running status as well as name: 1=running, 0=stopped (default: False)\n", + "\n", + "plash_cli 0.3.14\n" ] } ],