Skip to content

Commit 285ebe1

Browse files
RensDimmendaalRensDimmendaal
committed
add plash_apps cmd to docs
1 parent bec636f commit 285ebe1

1 file changed

Lines changed: 101 additions & 68 deletions

File tree

‎nbs/reference/00_cli.ipynb‎

Lines changed: 101 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@
3939
"name": "stdout",
4040
"output_type": "stream",
4141
"text": [
42-
"usage: plash_login [-h]\n",
43-
"\n",
44-
"Authenticate CLI with server and save config\n",
45-
"\n",
46-
"options:\n",
47-
" -h, --help show this help message and exit\n",
42+
"usage: plash_login [-h]\r\n",
43+
"\r\n",
44+
"Authenticate CLI with server and save config\r\n",
45+
"\r\n",
46+
"options:\r\n",
47+
" -h, --help show this help message and exit\r\n",
4848
"\n"
4949
]
5050
}
@@ -54,6 +54,39 @@
5454
"plash_login --help"
5555
]
5656
},
57+
{
58+
"cell_type": "markdown",
59+
"id": "d68f6131",
60+
"metadata": {},
61+
"source": [
62+
"## plash_apps"
63+
]
64+
},
65+
{
66+
"cell_type": "code",
67+
"execution_count": null,
68+
"id": "a27502f9",
69+
"metadata": {},
70+
"outputs": [
71+
{
72+
"name": "stdout",
73+
"output_type": "stream",
74+
"text": [
75+
"usage: plash_apps [-h]\r\n",
76+
"\r\n",
77+
"List all your deployed apps\r\n",
78+
"\r\n",
79+
"options:\r\n",
80+
" -h, --help show this help message and exit\r\n",
81+
"\n"
82+
]
83+
}
84+
],
85+
"source": [
86+
"%%bash\n",
87+
"plash_apps --help"
88+
]
89+
},
5790
{
5891
"cell_type": "markdown",
5992
"id": "0fed0889",
@@ -72,14 +105,14 @@
72105
"name": "stdout",
73106
"output_type": "stream",
74107
"text": [
75-
"usage: plash_deploy [-h] [--path PATH] [--app_id APP_ID]\n",
76-
"\n",
77-
"Ship your app to production\n",
78-
"\n",
79-
"options:\n",
80-
" -h, --help show this help message and exit\n",
81-
" --path PATH Path to project (default: .)\n",
82-
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
108+
"usage: plash_deploy [-h] [--path PATH] [--app_id APP_ID]\r\n",
109+
"\r\n",
110+
"Ship your app to production\r\n",
111+
"\r\n",
112+
"options:\r\n",
113+
" -h, --help show this help message and exit\r\n",
114+
" --path PATH Path to project (default: .)\r\n",
115+
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
83116
"\n"
84117
]
85118
}
@@ -107,14 +140,14 @@
107140
"name": "stdout",
108141
"output_type": "stream",
109142
"text": [
110-
"usage: plash_view [-h] [--path PATH] [--app_id APP_ID]\n",
111-
"\n",
112-
"Open your app in the browser\n",
113-
"\n",
114-
"options:\n",
115-
" -h, --help show this help message and exit\n",
116-
" --path PATH Path to project directory (default: .)\n",
117-
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
143+
"usage: plash_view [-h] [--path PATH] [--app_id APP_ID]\r\n",
144+
"\r\n",
145+
"Open your app in the browser\r\n",
146+
"\r\n",
147+
"options:\r\n",
148+
" -h, --help show this help message and exit\r\n",
149+
" --path PATH Path to project directory (default: .)\r\n",
150+
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
118151
"\n"
119152
]
120153
}
@@ -142,14 +175,14 @@
142175
"name": "stdout",
143176
"output_type": "stream",
144177
"text": [
145-
"usage: plash_start [-h] [--path PATH] [--app_id APP_ID]\n",
146-
"\n",
147-
"Access the '/start' endpoint for your app\n",
148-
"\n",
149-
"options:\n",
150-
" -h, --help show this help message and exit\n",
151-
" --path PATH Path to project (default: .)\n",
152-
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
178+
"usage: plash_start [-h] [--path PATH] [--app_id APP_ID]\r\n",
179+
"\r\n",
180+
"Access the '/start' endpoint for your app\r\n",
181+
"\r\n",
182+
"options:\r\n",
183+
" -h, --help show this help message and exit\r\n",
184+
" --path PATH Path to project (default: .)\r\n",
185+
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
153186
"\n"
154187
]
155188
}
@@ -177,14 +210,14 @@
177210
"name": "stdout",
178211
"output_type": "stream",
179212
"text": [
180-
"usage: plash_stop [-h] [--path PATH] [--app_id APP_ID]\n",
181-
"\n",
182-
"Access the '/stop' endpoint for your app\n",
183-
"\n",
184-
"options:\n",
185-
" -h, --help show this help message and exit\n",
186-
" --path PATH Path to project (default: .)\n",
187-
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
213+
"usage: plash_stop [-h] [--path PATH] [--app_id APP_ID]\r\n",
214+
"\r\n",
215+
"Access the '/stop' endpoint for your app\r\n",
216+
"\r\n",
217+
"options:\r\n",
218+
" -h, --help show this help message and exit\r\n",
219+
" --path PATH Path to project (default: .)\r\n",
220+
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
188221
"\n"
189222
]
190223
}
@@ -212,17 +245,17 @@
212245
"name": "stdout",
213246
"output_type": "stream",
214247
"text": [
215-
"usage: plash_logs [-h] [--path PATH] [--app_id APP_ID] [--mode {build,app}]\n",
216-
" [--tail]\n",
217-
"\n",
218-
"Prints the logs for your deployed app\n",
219-
"\n",
220-
"options:\n",
221-
" -h, --help show this help message and exit\n",
222-
" --path PATH Path to project (default: .)\n",
223-
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
224-
" --mode {build,app} Choose between build or app logs (default: build)\n",
225-
" --tail Tail the logs (default: False)\n",
248+
"usage: plash_logs [-h] [--path PATH] [--app_id APP_ID] [--mode {build,app}]\r\n",
249+
" [--tail]\r\n",
250+
"\r\n",
251+
"Prints the logs for your deployed app\r\n",
252+
"\r\n",
253+
"options:\r\n",
254+
" -h, --help show this help message and exit\r\n",
255+
" --path PATH Path to project (default: .)\r\n",
256+
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
257+
" --mode {build,app} Choose between build or app logs (default: build)\r\n",
258+
" --tail Tail the logs (default: False)\r\n",
226259
"\n"
227260
]
228261
}
@@ -250,16 +283,16 @@
250283
"name": "stdout",
251284
"output_type": "stream",
252285
"text": [
253-
"usage: plash_download [-h] [--path PATH] [--app_id APP_ID]\n",
254-
" [--save_path SAVE_PATH]\n",
255-
"\n",
256-
"Download your deployed app\n",
257-
"\n",
258-
"options:\n",
259-
" -h, --help show this help message and exit\n",
260-
" --path PATH Path to project (default: .)\n",
261-
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
262-
" --save_path SAVE_PATH Save path (optional) (default: download)\n",
286+
"usage: plash_download [-h] [--path PATH] [--app_id APP_ID]\r\n",
287+
" [--save_path SAVE_PATH]\r\n",
288+
"\r\n",
289+
"Download your deployed app\r\n",
290+
"\r\n",
291+
"options:\r\n",
292+
" -h, --help show this help message and exit\r\n",
293+
" --path PATH Path to project (default: .)\r\n",
294+
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
295+
" --save_path SAVE_PATH Save path (optional) (default: download)\r\n",
263296
"\n"
264297
]
265298
}
@@ -287,15 +320,15 @@
287320
"name": "stdout",
288321
"output_type": "stream",
289322
"text": [
290-
"usage: plash_delete [-h] [--path PATH] [--app_id APP_ID] [--force]\n",
291-
"\n",
292-
"Delete your deployed app\n",
293-
"\n",
294-
"options:\n",
295-
" -h, --help show this help message and exit\n",
296-
" --path PATH Path to project (default: .)\n",
297-
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
298-
" --force Skip confirmation prompt (default: False)\n",
323+
"usage: plash_delete [-h] [--path PATH] [--app_id APP_ID] [--force]\r\n",
324+
"\r\n",
325+
"Delete your deployed app\r\n",
326+
"\r\n",
327+
"options:\r\n",
328+
" -h, --help show this help message and exit\r\n",
329+
" --path PATH Path to project (default: .)\r\n",
330+
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
331+
" --force Skip confirmation prompt (default: False)\r\n",
299332
"\n"
300333
]
301334
}

0 commit comments

Comments
 (0)