ordinary 0.5.47

Ordinary CLI
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
# Command-Line Help for `ordinary`

This document contains the help content for the `ordinary` command-line program.

**Command Overview:**

* [`ordinary`]#ordinary
* [`ordinary new`]#ordinary-new
* [`ordinary build`]#ordinary-build
* [`ordinary templates`]#ordinary-templates
* [`ordinary templates add`]#ordinary-templates-add
* [`ordinary templates upload`]#ordinary-templates-upload
* [`ordinary content`]#ordinary-content
* [`ordinary content definition`]#ordinary-content-definition
* [`ordinary content definition add`]#ordinary-content-definition-add
* [`ordinary content object`]#ordinary-content-object
* [`ordinary content object add`]#ordinary-content-object-add
* [`ordinary content update`]#ordinary-content-update
* [`ordinary assets`]#ordinary-assets
* [`ordinary assets write`]#ordinary-assets-write
* [`ordinary models`]#ordinary-models
* [`ordinary models add`]#ordinary-models-add
* [`ordinary models items`]#ordinary-models-items
* [`ordinary models items list`]#ordinary-models-items-list
* [`ordinary actions`]#ordinary-actions
* [`ordinary actions add`]#ordinary-actions-add
* [`ordinary actions install`]#ordinary-actions-install
* [`ordinary integrations`]#ordinary-integrations
* [`ordinary integrations add`]#ordinary-integrations-add
* [`ordinary accounts`]#ordinary-accounts
* [`ordinary accounts register`]#ordinary-accounts-register
* [`ordinary accounts login`]#ordinary-accounts-login
* [`ordinary accounts logout`]#ordinary-accounts-logout
* [`ordinary accounts password`]#ordinary-accounts-password
* [`ordinary accounts password reset`]#ordinary-accounts-password-reset
* [`ordinary accounts invite`]#ordinary-accounts-invite
* [`ordinary accounts current`]#ordinary-accounts-current
* [`ordinary accounts list`]#ordinary-accounts-list
* [`ordinary accounts switch`]#ordinary-accounts-switch
* [`ordinary app`]#ordinary-app
* [`ordinary app deploy`]#ordinary-app-deploy
* [`ordinary app patch`]#ordinary-app-patch
* [`ordinary app migrate`]#ordinary-app-migrate
* [`ordinary app kill`]#ordinary-app-kill
* [`ordinary app download`]#ordinary-app-download
* [`ordinary app logs`]#ordinary-app-logs
* [`ordinary app accounts`]#ordinary-app-accounts
* [`ordinary app accounts list`]#ordinary-app-accounts-list

## `ordinary`

Ordinary CLI

**Usage:** `ordinary [OPTIONS] <COMMAND>`

###### **Subcommands:**

* `new` — create a new Ordinary project
* `build` — build your Ordinary project
* `templates` — manage templates in your Ordinary project
* `content` — manage content in your Ordinary project
* `assets` — manage assets in your Ordinary project
* `models` — manage models in your Ordinary project
* `actions` — manage actions in your Ordinary project
* `integrations` — manage integrations in your Ordinary project
* `accounts` — manage accounts connected to `ordinaryd`
* `app` — manage applications running on `ordinaryd`

###### **Options:**

* `-v`, `--verbose` — Increase logging verbosity
* `-q`, `--quiet` — Decrease logging verbosity
* `--pretty` — whether to pretty print events to stdio

  Default value: `false`
* `-p`, `--project <PROJECT>` — project path

  Default value: `.`
* `--insecure` — use HTTP instead of HTTPS

  Default value: `false`
* `--host-domain <HOST_DOMAIN>` — should only be necessary with localhost or when addressing by IP
* `--danger-accept-invalid-certs` — DANGER: only use when working with self-signed localhost certs

  Default value: `false`



## `ordinary new`

create a new Ordinary project

**Usage:** `ordinary new <PATH> <DOMAIN>`

###### **Arguments:**

* `<PATH>` — project path
* `<DOMAIN>` — project domain



## `ordinary build`

build your Ordinary project

**Usage:** `ordinary build [OPTIONS]`

###### **Options:**

* `-i`, `--ignore-cache` — build project without checking the cache

  Default value: `false`



## `ordinary templates`

manage templates in your Ordinary project

**Usage:** `ordinary templates <COMMAND>`

###### **Subcommands:**

* `add` — add a new template to the Ordinary project
* `upload` — upload templates to application running on `ordinaryd` instance



## `ordinary templates add`

add a new template to the Ordinary project

**Usage:** `ordinary templates add <NAME> <ROUTE> <MIME>`

###### **Arguments:**

* `<NAME>` — template name
* `<ROUTE>` — HTTP route (must start with leading "/")
* `<MIME>` — MIME type for template output: [reference]https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/MIME_types/Common_types



## `ordinary templates upload`

upload templates to application running on `ordinaryd` instance

**Usage:** `ordinary templates upload [OPTIONS]`

###### **Options:**

* `-n`, `--name <NAME>` — name of a specific template to upload (optional). will upload all when the `--name` flag is not passed



## `ordinary content`

manage content in your Ordinary project

**Usage:** `ordinary content <COMMAND>`

###### **Subcommands:**

* `definition` — manage content definitions for Ordinary project
* `object` — manage content objects for Ordinary project
* `update` — update content for application running on `ordinaryd` instance



## `ordinary content definition`

manage content definitions for Ordinary project

**Usage:** `ordinary content definition <COMMAND>`

###### **Subcommands:**

* `add` — add a content definition to your Ordinary project



## `ordinary content definition add`

add a content definition to your Ordinary project

**Usage:** `ordinary content definition add <NAME>`

###### **Arguments:**

* `<NAME>` — content definition / instance name



## `ordinary content object`

manage content objects for Ordinary project

**Usage:** `ordinary content object <COMMAND>`

###### **Subcommands:**

* `add` — add a content object to your Ordinary project



## `ordinary content object add`

add a content object to your Ordinary project

**Usage:** `ordinary content object add <JSON>`

###### **Arguments:**

* `<JSON>` — json value of content object



## `ordinary content update`

update content for application running on `ordinaryd` instance

**Usage:** `ordinary content update`



## `ordinary assets`

manage assets in your Ordinary project

**Usage:** `ordinary assets <COMMAND>`

###### **Subcommands:**

* `write` — write assets to application running on `ordinaryd` instance



## `ordinary assets write`

write assets to application running on `ordinaryd` instance

**Usage:** `ordinary assets write [OPTIONS]`

###### **Options:**

* `-n`, `--name <NAME>` — name of a specific asset to write (optional). will write all when the `--name` flag is not passed



## `ordinary models`

manage models in your Ordinary project

**Usage:** `ordinary models <COMMAND>`

###### **Subcommands:**

* `add` — add a new model to your Ordinary project
* `items` — manage model items for the application running on an `ordinaryd` instance



## `ordinary models add`

add a new model to your Ordinary project

**Usage:** `ordinary models add <NAME> [UUID_VERSION]`

###### **Arguments:**

* `<NAME>` — name of the model
* `<UUID_VERSION>` — UUID version

  Possible values: `v4`, `v7`




## `ordinary models items`

manage model items for the application running on an `ordinaryd` instance

**Usage:** `ordinary models items <COMMAND>`

###### **Subcommands:**

* `list` — list model items for the application running on an `ordinaryd` instance



## `ordinary models items list`

list model items for the application running on an `ordinaryd` instance

**Usage:** `ordinary models items list [OPTIONS] <NAME>`

###### **Arguments:**

* `<NAME>` — name of the model

###### **Options:**

* `--json` — for applications that need to consume stdio or pipe to `jq`

  Default value: `false`



## `ordinary actions`

manage actions in your Ordinary project

**Usage:** `ordinary actions <COMMAND>`

###### **Subcommands:**

* `add` — add a new action to your Ordinary project
* `install` — install actions to application running on `ordinaryd` instance



## `ordinary actions add`

add a new action to your Ordinary project

**Usage:** `ordinary actions add <NAME> <LANG> [TRANSACTIONAL]`

###### **Arguments:**

* `<NAME>` — action name
* `<LANG>` — language the action runs
* `<TRANSACTIONAL>` — whether the action is transactional

  Possible values: `true`, `false`




## `ordinary actions install`

install actions to application running on `ordinaryd` instance

**Usage:** `ordinary actions install [OPTIONS]`

###### **Options:**

* `-n`, `--name <NAME>` — name of a specific action to install (optional). will install all when the `--name` flag is not passed



## `ordinary integrations`

manage integrations in your Ordinary project

**Usage:** `ordinary integrations <COMMAND>`

###### **Subcommands:**

* `add` — add a new integration to your Ordinary project



## `ordinary integrations add`

add a new integration to your Ordinary project

**Usage:** `ordinary integrations add <NAME> <ENDPOINT> <PROTOCOL>`

###### **Arguments:**

* `<NAME>` — name of the integration
* `<ENDPOINT>` — url endpoint for integration
* `<PROTOCOL>` — protocol for the integration

  Possible values: `REST`




## `ordinary accounts`

manage accounts connected to `ordinaryd`

**Usage:** `ordinary accounts <COMMAND>`

###### **Subcommands:**

* `register` — register a new account
* `login` — log in to an existing account
* `logout` — log out of a logged in account
* `password` — password management
* `invite` — invite another user to a project
* `current` — display info for current account
* `list` — list all logged in accounts
* `switch` — switch to a different logged in account



## `ordinary accounts register`

register a new account

**Usage:** `ordinary accounts register [OPTIONS] <HOST> <ACCOUNT>`

###### **Arguments:**

* `<HOST>` — url where `orindaryd` is running
* `<ACCOUNT>` — name of your account with the host

###### **Options:**

* `--password <PASSWORD>` — password for your new account

  Default value: ``
* `--invite <INVITE>` — base64 encoded invite token

  Default value: ``



## `ordinary accounts login`

log in to an existing account

**Usage:** `ordinary accounts login [OPTIONS] <HOST> <ACCOUNT>`

###### **Arguments:**

* `<HOST>` — url where `orindaryd` is running
* `<ACCOUNT>` — name of your account with the host

###### **Options:**

* `--password <PASSWORD>` — password for your existing account

  Default value: ``
* `--mfa <MFA>` — 6 digit TOTP MFA code

  Default value: ``



## `ordinary accounts logout`

log out of a logged in account

**Usage:** `ordinary accounts logout`



## `ordinary accounts password`

password management

**Usage:** `ordinary accounts password <COMMAND>`

###### **Subcommands:**

* `reset` — reset your password



## `ordinary accounts password reset`

reset your password

**Usage:** `ordinary accounts password reset [OPTIONS]`

###### **Options:**

* `--password <PASSWORD>` — existing password

  Default value: ``
* `--new-password <NEW_PASSWORD>` — new password to be set

  Default value: ``
* `--mfa <MFA>` — 6 digit TOTP MFA code

  Default value: ``



## `ordinary accounts invite`

invite another user to a project

**Usage:** `ordinary accounts invite <ACCOUNT> [PERMISSIONS]...`

###### **Arguments:**

* `<ACCOUNT>` — name of the account to be invited & registered
* `<PERMISSIONS>` — which permissions to include in their set

  Possible values: `admin`, `read`, `write`, `update`, `upload`, `install`, `deploy`, `bridge`, `kill`, `erase`




## `ordinary accounts current`

display info for current account

format: <host> <account> <project> <permissions> <session exp>

**Usage:** `ordinary accounts current`



## `ordinary accounts list`

list all logged in accounts

**Usage:** `ordinary accounts list`



## `ordinary accounts switch`

switch to a different logged in account

**Usage:** `ordinary accounts switch <HOST> <ACCOUNT>`

###### **Arguments:**

* `<HOST>` — location where `orindaryd` is running
* `<ACCOUNT>` — name of the account you'd like to switch to



## `ordinary app`

manage applications running on `ordinaryd`

**Usage:** `ordinary app <COMMAND>`

###### **Subcommands:**

* `deploy` — deploy a new application
* `patch` — push a configuration level change
* `migrate` — push a configuration change which will modify the shape of your data stores
* `kill` — kill a running instance of the application
* `download` — download an application as static files
* `logs` — query application logs
* `accounts` — manage application accounts



## `ordinary app deploy`

deploy a new application

**Usage:** `ordinary app deploy`



## `ordinary app patch`

push a configuration level change

**Usage:** `ordinary app patch`



## `ordinary app migrate`

push a configuration change which will modify the shape of your data stores

(i.e. a structural change to model or content definitions)

**Usage:** `ordinary app migrate`



## `ordinary app kill`

kill a running instance of the application

**Usage:** `ordinary app kill`



## `ordinary app download`

download an application as static files

**Usage:** `ordinary app download [OPTIONS]`

###### **Options:**

* `-u`, `--url <URL>` — url override. will use project domain by default

  Default value: ``
* `-o`, `--out <OUT>` — where to store downloaded files

  Default value: `out`



## `ordinary app logs`

query application logs

**Usage:** `ordinary app logs [OPTIONS] <FORMAT> <QUERY>`

###### **Arguments:**

* `<FORMAT>` — format

  Possible values: `all`, `top`, `count`

* `<QUERY>`[reference]https://quickwit.io/docs/reference/query-language

###### **Options:**

* `--limit <LIMIT>` — limit (when using 'top' format)
* `--json` — for applications that need to consume stdio or pipe to `jq`

  Default value: `false`



## `ordinary app accounts`

manage application accounts

**Usage:** `ordinary app accounts <COMMAND>`

###### **Subcommands:**

* `list` — list application accounts



## `ordinary app accounts list`

list application accounts

**Usage:** `ordinary app accounts list [OPTIONS]`

###### **Options:**

* `--json` — for applications that need to consume stdio or pipe to `jq`

  Default value: `false`



<hr/>

<small><i>
    This document was generated automatically by
    <a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>.
</i></small>