This repository was archived by the owner on Jul 17, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathoxide.json
More file actions
3513 lines (3513 loc) · 104 KB
/
Copy pathoxide.json
File metadata and controls
3513 lines (3513 loc) · 104 KB
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
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"title": "oxide",
"excerpt": "Work seamlessly with Oxide from the command line",
"about": "Work seamlessly with Oxide from the command line.\n\nEnvironment variables that can be used with oxide. Additionally to those listed below, some flags have a corresponding environment variable. For example, most of the time, the `--organization,-o` flag is mapped to the `OXIDE_ORG` environment variable.\n\nOXIDE_TOKEN: an authentication token for Oxide API requests. Setting this avoids being prompted to authenticate and takes precedence over previously stored credentials.\n\nOXIDE_HOST: specify the Oxide hostname for commands that would otherwise assume the \"api.oxide.computer\" host.\n\nOXIDE_BROWSER, BROWSER (in order of precedence): the web browser to use for opening links.\n\nDEBUG: set to any value to enable verbose output to standard error.\n\nNO_COLOR: set to any value to avoid printing ANSI escape sequences for color output.\n\nCLICOLOR: set to \"0\" to disable printing ANSI colors in output.\n\nCLICOLOR_FORCE: set to a value other than \"0\" to keep ANSI colors in output even when the output is piped.\n\nOXIDE_FORCE_TTY: set to any value to force terminal-style output even when the output is redirected. When the value is a number, it is interpreted as the number of columns available in the viewport. When the value is a percentage, it will be applied against the number of columns available in the current viewport.\n\nOXIDE_NO_UPDATE_NOTIFIER: set to any value to disable update notifications. By default, oxide checks for new releases once every 24 hours and displays an upgrade notice on standard error if a newer version was found.\n\nOXIDE_CONFIG_DIR: the directory where oxide will store configuration files. Default: \"$XDG_CONFIG_HOME/oxide\" or \"$HOME/.config/oxide\".\n\nAuthentication\n\nYou can get an access token running `oxide auth login`. This will contact `OXIDE_HOST` and attempt an OAuth 2.0 Device Authorization Grant. The CLI will attempt to open a browser window with which you can login (via SAML or other IdP method) and type in or verify the user code printed in the terminal. After a successful login and code verification, a token associated with the logged-in user will be granted and stored in the config file.",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "V",
"long": "version",
"help": "Print version information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
],
"subcommands": [
{
"title": "alias",
"excerpt": "Create command shortcuts.",
"about": "Create command shortcuts.\n\nAliases can be used to make shortcuts for oxide commands or to compose multiple commands.\nRun \"oxide help alias set\" to learn more.",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
],
"subcommands": [
{
"title": "set",
"excerpt": "Create a shortcut for an oxide command.",
"about": "Create a shortcut for an oxide command.\n\nDefine a word that will expand to a full oxide command when invoked.\n\nThe expansion may specify additional arguments and flags. If the expansion includes\npositional placeholders such as \"$1\", extra arguments that follow the alias will be\ninserted appropriately. Otherwise, extra arguments will be appended to the expanded\ncommand.\n\nUse \"-\" as expansion argument to read the expansion string from standard input. This\nis useful to avoid quoting issues when defining expansions.\n\nIf the expansion starts with \"!\" or if \"--shell\" was given, the expansion is a shell\nexpression that will be evaluated through the \"sh\" interpreter when the alias is\ninvoked. This allows for chaining multiple commands via piping and redirection.",
"args": [
{
"short": "s",
"long": "shell",
"help": "Declare an alias to be passed through a shell interpreter"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "delete",
"excerpt": "Delete an alias.",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "list",
"excerpt": "List your aliases.",
"about": "List your aliases.\n\nThis command prints out all of the aliases oxide is configured to use.",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "help",
"excerpt": "Print this message or the help of the given subcommand(s)",
"args": [
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
}
]
},
{
"title": "api",
"excerpt": "Makes an authenticated HTTP request to the Oxide API and prints the response.",
"about": "Makes an authenticated HTTP request to the Oxide API and prints the response.\n\nThe endpoint argument should be a path of a Oxide API endpoint.\n\nThe default HTTP request method is \"GET\" normally and \"POST\" if any parameters\nwere added. Override the method with `--method`.\n\nPass one or more `-f/--raw-field` values in \"key=value\" format to add static string\nparameters to the request payload. To add non-string or otherwise dynamic values, see\n`--field` below. Note that adding request parameters will automatically switch the\nrequest method to POST. To send the parameters as a GET query string instead, use\n`--method GET`.\n\nThe `-F/--field` flag has magic type conversion based on the format of the value:\n\n- literal values \"true\", \"false\", \"null\", and integer/float numbers get converted to\n appropriate JSON types;\n- if the value starts with \"@\", the rest of the value is interpreted as a\n filename to read the value from. Pass \"-\" to read from standard input.\n\nRaw request body may be passed from the outside via a file specified by `--input`.\nPass \"-\" to read from standard input. In this mode, parameters specified via\n`--field` flags are serialized into URL query parameters.\n\nIn `--paginate` mode, all pages of results will sequentially be requested until\nthere are no more pages of results.",
"args": [
{
"short": "X",
"long": "method",
"help": "The HTTP method for the request"
},
{
"long": "paginate",
"help": "Make additional HTTP requests to fetch all pages of results"
},
{
"short": "F",
"long": "field",
"help": "Add a typed parameter in key=value format"
},
{
"short": "f",
"long": "raw-field",
"help": "Add a string parameter in key=value format"
},
{
"long": "input",
"help": "The file to use as body for the HTTP request (use \"-\" to read from standard input)"
},
{
"short": "i",
"long": "include",
"help": "Include HTTP response headers in the output"
},
{
"short": "H",
"long": "header",
"help": "Add a HTTP request header in `key:value` format"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "auth",
"excerpt": "Login, logout, and get the status of your authentication.",
"about": "Login, logout, and get the status of your authentication.\n\nManage `oxide`'s authentication state.",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
],
"subcommands": [
{
"title": "login",
"excerpt": "Authenticate with an Oxide host.",
"about": "Authenticate with an Oxide host.\n\nAlternatively, pass in a token on standard input by using `--with-token`.\n\n # start interactive setup\n $ oxide auth login\n\n # authenticate against a specific Oxide instance by reading the token from a file\n $ oxide auth login --with-token --host oxide.internal < mytoken.txt\n\n # authenticate with a specific Oxide instance\n $ oxide auth login --host oxide.internal\n\n # authenticate with an insecure Oxide instance (not recommended)\n $ oxide auth login --host http://oxide.internal",
"args": [
{
"long": "with-token",
"help": "Read token from standard input"
},
{
"short": "H",
"long": "host",
"help": "The host of the Oxide instance to authenticate with. This assumes the instance is an `https://` url, if not otherwise specified as `http://`"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "logout",
"excerpt": "Log out of an Oxide host.",
"about": "Log out of an Oxide host.\n\nThis command removes the authentication configuration for a host either specified\ninteractively or via `--host`.\n\n $ oxide auth logout\n # => select what host to log out of via a prompt\n\n $ oxide auth logout --host oxide.internal\n # => log out of specified host",
"args": [
{
"short": "H",
"long": "host",
"help": "The hostname of the Oxide instance to log out of"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "status",
"excerpt": "Verifies and displays information about your authentication state.",
"about": "Verifies and displays information about your authentication state.\n\nThis command will test your authentication state for each Oxide host that `oxide`\nknows about and report on any issues.",
"args": [
{
"short": "t",
"long": "show-token",
"help": "Display the auth token"
},
{
"short": "H",
"long": "host",
"help": "Check a specific hostname's auth status"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "help",
"excerpt": "Print this message or the help of the given subcommand(s)",
"args": [
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
}
]
},
{
"title": "completion",
"excerpt": "Generate shell completion scripts.",
"about": "Generate shell completion scripts.\n\nWhen installing Oxide CLI through a package manager, it's possible that\nno additional shell configuration is necessary to gain completion support. For\nHomebrew, see <https://docs.brew.sh/Shell-Completion>.\n\nIf you need to set up completions manually, follow the instructions below. The exact\nconfig file locations might vary based on your system. Make sure to restart your\nshell before testing whether completions are working.\n\n### bash\n\nFirst, ensure that you install `bash-completion` using your package manager.\n\nAfter, add this to your `~/.bash_profile`:\n\n eval \"$(oxide completion -s bash)\"\n\n### zsh\nGenerate a `_oxide` completion script and put it somewhere in your `$fpath`:\n\n oxide completion -s zsh > /usr/local/share/zsh/site-functions/_oxide\n\nEnsure that the following is present in your `~/.zshrc`:\n\n autoload -U compinit\n compinit -i\n\nZsh version 5.7 or later is recommended.\n\n### fish\n\nGenerate a `oxide.fish` completion script:\n\n oxide completion -s fish > ~/.config/fish/completions/oxide.fish\n\n### PowerShell\n\nOpen your profile script with:\n\n mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue\n notepad $profile\n\nAdd the line and save the file:\n\n Invoke-Expression -Command $(oxide completion -s powershell | Out-String)",
"args": [
{
"short": "s",
"long": "shell",
"help": "Shell type: {bash|zsh|fish|powershell}"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "config",
"excerpt": "Manage configuration for oxide.",
"about": "Manage configuration for oxide.\n\nCurrent respected settings:\n- editor: the text editor program to use for authoring text\n- prompt: toggle interactive prompting in the terminal (default: \"enabled\")\n- browser: the web browser to use for opening URLs\n- format: the formatting style for command output",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
],
"subcommands": [
{
"title": "set",
"excerpt": "Update configuration with a value for the given key.",
"args": [
{
"short": "H",
"long": "host",
"help": "Set per-host setting"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "list",
"excerpt": "Print a list of configuration keys and values.",
"args": [
{
"short": "H",
"long": "host",
"help": "Get per-host configuration"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "get",
"excerpt": "Print the value of a given configuration key.",
"args": [
{
"short": "H",
"long": "host",
"help": "Get per-host setting"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "help",
"excerpt": "Print this message or the help of the given subcommand(s)",
"args": [
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
}
]
},
{
"title": "disk",
"excerpt": "Create, list, edit, view, and delete disks.",
"about": "Create, list, edit, view, and delete disks.\n\nAdditionally, attach and detach disks to an instance.",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
],
"subcommands": [
{
"title": "attach",
"excerpt": "Attach a disk to an instance.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project that holds the disk and instance"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "detach",
"excerpt": "Detach a disk from an instance.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project that holds the disk and instance"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "edit",
"excerpt": "Edit disk settings.",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "list",
"excerpt": "List disks.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project that holds the disks"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"short": "s",
"long": "sort-by",
"help": "The order in which to sort the results"
},
{
"short": "l",
"long": "limit",
"help": "Maximum number of items to list"
},
{
"long": "paginate",
"help": "Make additional HTTP requests to fetch all pages"
},
{
"short": "f",
"long": "format",
"help": "Display output in json, yaml, or table format"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "create",
"excerpt": "Create a new disk.",
"about": "Create a new disk.\n\nTo create a disk interactively, use `oxide disk create` with no arguments.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project that holds the disk"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"short": "D",
"long": "description",
"help": "The description for the disk"
},
{
"long": "disk-source",
"help": "initial source for this disk"
},
{
"long": "size",
"help": "total size of the Disk in bytes"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "view",
"excerpt": "View disk.",
"about": "View disk.\n\nDisplay information about an Oxide disk.\n\nWith `--web`, open the disk in a web browser instead.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project that holds the disk"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"short": "w",
"long": "web",
"help": "Open the disk in the browser"
},
{
"short": "f",
"long": "format",
"help": "Display output in json, yaml, or table format"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "delete",
"excerpt": "Delete disk.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project to delete the disk from"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"long": "confirm",
"help": "Confirm deletion without prompting"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "help",
"excerpt": "Print this message or the help of the given subcommand(s)",
"args": [
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
}
]
},
{
"title": "generate",
"excerpt": "Generate various documentation files for the oxide command line.",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
],
"subcommands": [
{
"title": "markdown",
"excerpt": "Generate markdown documentation.",
"args": [
{
"short": "D",
"long": "dir",
"help": "Path directory where you want to output the generated files"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "man-pages",
"excerpt": "Generate manual pages.",
"args": [
{
"short": "D",
"long": "dir",
"help": "Path directory where you want to output the generated files"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "json",
"excerpt": "Generate CLI docs in a single JSON file.",
"args": [
{
"short": "D",
"long": "dir",
"help": "Path directory where you want to output the generated files"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "help",
"excerpt": "Print this message or the help of the given subcommand(s)",
"args": [
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
}
]
},
{
"title": "image",
"excerpt": "Create, list, view, and delete images.",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
],
"subcommands": [
{
"title": "global",
"excerpt": "Create, list, view, and delete global images.",
"args": [
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
],
"subcommands": [
{
"title": "list",
"excerpt": "List images.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project that holds the images"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"short": "s",
"long": "sort-by",
"help": "The order in which to sort the results"
},
{
"short": "l",
"long": "limit",
"help": "Maximum number of items to list"
},
{
"long": "paginate",
"help": "Make additional HTTP requests to fetch all pages"
},
{
"short": "f",
"long": "format",
"help": "Display output in json, yaml, or table format"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "create",
"excerpt": "Create a new image.",
"about": "Create a new image.\n\nTo create a image interactively, use `oxide image create` with no arguments.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project that holds the image"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"short": "b",
"long": "block-size",
"help": "block size in bytes"
},
{
"short": "D",
"long": "description",
"help": "The description for the image"
},
{
"short": "s",
"long": "source",
"help": "The source of the image's contents"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "view",
"excerpt": "View image.",
"about": "View image.\n\nDisplay information about an Oxide image.\n\nWith `--web`, open the image in a web browser instead.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project that holds the image"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"short": "w",
"long": "web",
"help": "Open the image in the browser"
},
{
"short": "f",
"long": "format",
"help": "Display output in json, yaml, or table format"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "delete",
"excerpt": "Delete image.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project to delete the image from"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"long": "confirm",
"help": "Confirm deletion without prompting"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "help",
"excerpt": "Print this message or the help of the given subcommand(s)",
"args": [
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
}
]
},
{
"title": "list",
"excerpt": "List images.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project that holds the images"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"short": "s",
"long": "sort-by",
"help": "The order in which to sort the results"
},
{
"short": "l",
"long": "limit",
"help": "Maximum number of items to list"
},
{
"long": "paginate",
"help": "Make additional HTTP requests to fetch all pages"
},
{
"short": "f",
"long": "format",
"help": "Display output in json, yaml, or table format"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",
"long": "debug",
"help": "Print debug info"
}
]
},
{
"title": "create",
"excerpt": "Create a new image.",
"about": "Create a new image.\n\nTo create a image interactively, use `oxide image create` with no arguments.",
"args": [
{
"short": "p",
"long": "project",
"help": "The project that holds the image"
},
{
"short": "o",
"long": "organization",
"help": "The organization that holds the project"
},
{
"short": "b",
"long": "block-size",
"help": "block size in bytes"
},
{
"short": "D",
"long": "description",
"help": "The description for the image"
},
{
"short": "s",
"long": "source",
"help": "The source of the image's contents"
},
{
"short": "h",
"long": "help",
"help": "Print help information"
},
{
"short": "d",