uffizzi-cli 2.0.34 → 2.0.35

Sign up to get free protection for your applications and to get access to all the features.
Files changed (125) hide show
  1. checksums.yaml +4 -4
  2. data/lib/uffizzi/cli/common.rb +1 -1
  3. data/lib/uffizzi/version.rb +1 -1
  4. data/man/uffizzi +53 -0
  5. data/man/uffizzi-account +29 -0
  6. data/man/uffizzi-account-list +26 -0
  7. data/man/uffizzi-account-list.html +103 -0
  8. data/man/uffizzi-account-list.ronn +19 -0
  9. data/man/uffizzi-account-set-default +29 -0
  10. data/man/uffizzi-account-set-default.html +105 -0
  11. data/man/uffizzi-account-set-default.ronn +22 -0
  12. data/man/uffizzi-account.html +106 -0
  13. data/man/uffizzi-account.ronn +23 -0
  14. data/man/uffizzi-cluster +37 -0
  15. data/man/uffizzi-cluster-create +49 -0
  16. data/man/uffizzi-cluster-create.ronn +41 -0
  17. data/man/uffizzi-cluster-delete +32 -0
  18. data/man/uffizzi-cluster-delete.ronn +24 -0
  19. data/man/uffizzi-cluster-describe +39 -0
  20. data/man/uffizzi-cluster-describe.ronn +30 -0
  21. data/man/uffizzi-cluster-list +34 -0
  22. data/man/uffizzi-cluster-list.ronn +26 -0
  23. data/man/uffizzi-cluster-update-kubeconfig +37 -0
  24. data/man/uffizzi-cluster-update-kubeconfig.ronn +29 -0
  25. data/man/uffizzi-cluster.ronn +32 -0
  26. data/man/uffizzi-compose +39 -0
  27. data/man/uffizzi-compose-create +67 -0
  28. data/man/uffizzi-compose-create.ronn +57 -0
  29. data/man/uffizzi-compose-delete +38 -0
  30. data/man/uffizzi-compose-delete.ronn +29 -0
  31. data/man/uffizzi-compose-describe +38 -0
  32. data/man/uffizzi-compose-describe.ronn +29 -0
  33. data/man/uffizzi-compose-events +38 -0
  34. data/man/uffizzi-compose-events.ronn +29 -0
  35. data/man/uffizzi-compose-list +58 -0
  36. data/man/uffizzi-compose-list.ronn +49 -0
  37. data/man/uffizzi-compose-service-list +42 -0
  38. data/man/uffizzi-compose-service-list.ronn +32 -0
  39. data/man/uffizzi-compose-service-logs +59 -0
  40. data/man/uffizzi-compose-service-logs.ronn +48 -0
  41. data/man/uffizzi-compose-update +61 -0
  42. data/man/uffizzi-compose-update.ronn +51 -0
  43. data/man/uffizzi-compose.ronn +33 -0
  44. data/man/uffizzi-compose_service_logs +59 -0
  45. data/man/uffizzi-compose_service_logs.ronn +50 -0
  46. data/man/uffizzi-config +65 -0
  47. data/man/uffizzi-config.ronn +55 -0
  48. data/man/uffizzi-connect +40 -0
  49. data/man/uffizzi-connect-acr +37 -0
  50. data/man/uffizzi-connect-acr.ronn +42 -0
  51. data/man/uffizzi-connect-docker-hub +34 -0
  52. data/man/uffizzi-connect-docker-hub.ronn +39 -0
  53. data/man/uffizzi-connect-docker-registry +37 -0
  54. data/man/uffizzi-connect-docker-registry.ronn +41 -0
  55. data/man/uffizzi-connect-ecr +37 -0
  56. data/man/uffizzi-connect-ecr.ronn +42 -0
  57. data/man/uffizzi-connect-gcr +31 -0
  58. data/man/uffizzi-connect-gcr.ronn +36 -0
  59. data/man/uffizzi-connect-ghcr +34 -0
  60. data/man/uffizzi-connect-ghcr.ronn +40 -0
  61. data/man/uffizzi-connect.ronn +45 -0
  62. data/man/uffizzi-disconnect +37 -0
  63. data/man/uffizzi-disconnect.ronn +31 -0
  64. data/man/uffizzi-login +51 -0
  65. data/man/uffizzi-login-by-identity-token +29 -0
  66. data/man/uffizzi-login-by-identity-token.html +106 -0
  67. data/man/uffizzi-login-by-identity-token.ronn +21 -0
  68. data/man/uffizzi-login.html +113 -0
  69. data/man/uffizzi-login.ronn +41 -0
  70. data/man/uffizzi-logout +21 -0
  71. data/man/uffizzi-logout.ronn +19 -0
  72. data/man/uffizzi-preview +39 -0
  73. data/man/uffizzi-preview-create +67 -0
  74. data/man/uffizzi-preview-create.ronn +57 -0
  75. data/man/uffizzi-preview-delete +38 -0
  76. data/man/uffizzi-preview-delete.ronn +29 -0
  77. data/man/uffizzi-preview-describe +38 -0
  78. data/man/uffizzi-preview-describe.ronn +29 -0
  79. data/man/uffizzi-preview-events +38 -0
  80. data/man/uffizzi-preview-events.ronn +29 -0
  81. data/man/uffizzi-preview-list +58 -0
  82. data/man/uffizzi-preview-list.ronn +49 -0
  83. data/man/uffizzi-preview-service-list +42 -0
  84. data/man/uffizzi-preview-service-list.ronn +32 -0
  85. data/man/uffizzi-preview-service-logs +59 -0
  86. data/man/uffizzi-preview-service-logs.ronn +48 -0
  87. data/man/uffizzi-preview-update +61 -0
  88. data/man/uffizzi-preview-update.ronn +51 -0
  89. data/man/uffizzi-preview.ronn +33 -0
  90. data/man/uffizzi-preview_service_logs +59 -0
  91. data/man/uffizzi-preview_service_logs.ronn +50 -0
  92. data/man/uffizzi-project +47 -0
  93. data/man/uffizzi-project-compose +40 -0
  94. data/man/uffizzi-project-compose-describe +37 -0
  95. data/man/uffizzi-project-compose-describe.ronn +29 -0
  96. data/man/uffizzi-project-compose-set +66 -0
  97. data/man/uffizzi-project-compose-set.ronn +57 -0
  98. data/man/uffizzi-project-compose-unset +35 -0
  99. data/man/uffizzi-project-compose-unset.ronn +27 -0
  100. data/man/uffizzi-project-compose.ronn +34 -0
  101. data/man/uffizzi-project-create +50 -0
  102. data/man/uffizzi-project-create.ronn +41 -0
  103. data/man/uffizzi-project-delete +32 -0
  104. data/man/uffizzi-project-delete.ronn +24 -0
  105. data/man/uffizzi-project-describe +43 -0
  106. data/man/uffizzi-project-describe.ronn +34 -0
  107. data/man/uffizzi-project-preview-describe +37 -0
  108. data/man/uffizzi-project-preview-describe.ronn +29 -0
  109. data/man/uffizzi-project-preview-set +66 -0
  110. data/man/uffizzi-project-preview-set.ronn +57 -0
  111. data/man/uffizzi-project-secret +37 -0
  112. data/man/uffizzi-project-secret-create +29 -0
  113. data/man/uffizzi-project-secret-create.ronn +21 -0
  114. data/man/uffizzi-project-secret-delete +29 -0
  115. data/man/uffizzi-project-secret-delete.ronn +21 -0
  116. data/man/uffizzi-project-secret-list +28 -0
  117. data/man/uffizzi-project-secret-list.ronn +20 -0
  118. data/man/uffizzi-project-secret.ronn +30 -0
  119. data/man/uffizzi-project-set-default +34 -0
  120. data/man/uffizzi-project-set-default.ronn +26 -0
  121. data/man/uffizzi-project.html +124 -0
  122. data/man/uffizzi-project.ronn +41 -0
  123. data/man/uffizzi.html +132 -0
  124. data/man/uffizzi.ronn +45 -0
  125. metadata +122 -1
data/man/uffizzi-login-by-identity-token ADDED
@@ -0,0 +1,29 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-LOGIN\-BY\-IDENTITY\-TOKEN" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-login\-by\-identity\-token\fR \- login to Uffizzi using a OIDC token provided by a CI/CD pipeline
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi uffizzi\-login\-by\-identity\-token [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline\.
13
+ If a user/account do not exist, Uffizzi will create them based on token payload\.
14
+
15
+ For more information on authentication and credential types, see:
16
+ https://docs\.uffizzi\.com/references/cli/
17
+ .fi
18
+ .SH "UFFIZZI WIDE FLAGS"
19
+ .nf
20
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
21
+ help for details\.
22
+ .fi
23
+ .SH "EXAMPLES"
24
+ .nf
25
+ To login from the CI/CD pipeline, run:
26
+
27
+ $ uffizzi uffizzi\-login\-by\-identity\-token \-\-server=uffizzi\.example\.com \-\-oidc\-token=[$CI_JOB_TOKEN]
28
+ .fi
29
+
data/man/uffizzi-login-by-identity-token.html ADDED
@@ -0,0 +1,106 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta http-equiv='content-type' content='text/html;charset=utf8'>
5
+ <meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
6
+ <title>login to Uffizzi using a OIDC token provided by a CI/CD pipeline</title>
7
+ <style type='text/css' media='all'>
8
+ /* style: man */
9
+ body#manpage {margin:0}
10
+ .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
11
+ .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
12
+ .mp h2 {margin:10px 0 0 0}
13
+ .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
14
+ .mp h3 {margin:0 0 0 4ex}
15
+ .mp dt {margin:0;clear:left}
16
+ .mp dt.flush {float:left;width:8ex}
17
+ .mp dd {margin:0 0 0 9ex}
18
+ .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
19
+ .mp pre {margin-bottom:20px}
20
+ .mp pre+h2,.mp pre+h3 {margin-top:22px}
21
+ .mp h2+pre,.mp h3+pre {margin-top:5px}
22
+ .mp img {display:block;margin:auto}
23
+ .mp h1.man-title {display:none}
24
+ .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
25
+ .mp h2 {font-size:16px;line-height:1.25}
26
+ .mp h1 {font-size:20px;line-height:2}
27
+ .mp {text-align:justify;background:#fff}
28
+ .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
29
+ .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
30
+ .mp u {text-decoration:underline}
31
+ .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
32
+ .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
33
+ .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
34
+ .mp b.man-ref {font-weight:normal;color:#434241}
35
+ .mp pre {padding:0 4ex}
36
+ .mp pre code {font-weight:normal;color:#434241}
37
+ .mp h2+pre,h3+pre {padding-left:0}
38
+ ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
39
+ ol.man-decor {width:100%}
40
+ ol.man-decor li.tl {text-align:left}
41
+ ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42
+ ol.man-decor li.tr {text-align:right;float:right}
43
+ </style>
44
+ </head>
45
+ <!--
46
+ The following styles are deprecated and will be removed at some point:
47
+ div#man, div#man ol.man, div#man ol.head, div#man ol.man.
48
+
49
+ The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
50
+ .man-navigation should be used instead.
51
+ -->
52
+ <body id='manpage'>
53
+ <div class='mp' id='man'>
54
+
55
+ <div class='man-navigation' style='display:none'>
56
+ <a href="#NAME">NAME</a>
57
+ <a href="#SYNOPSIS">SYNOPSIS</a>
58
+ <a href="#DESCRIPTION">DESCRIPTION</a>
59
+ <a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
60
+ <a href="#EXAMPLES">EXAMPLES</a>
61
+ </div>
62
+
63
+ <ol class='man-decor man-head man head'>
64
+ <li class='tl'>uffizzi-login-by-identity-token</li>
65
+ <li class='tc'></li>
66
+ <li class='tr'>uffizzi-login-by-identity-token</li>
67
+ </ol>
68
+
69
+
70
+
71
+ <h2 id="NAME">NAME</h2>
72
+ <p class="man-name">
73
+ <code>uffizzi-login-by-identity-token</code> - <span class="man-whatis">login to Uffizzi using a OIDC token provided by a CI/CD pipeline</span>
74
+ </p>
75
+ <h2 id="SYNOPSIS">SYNOPSIS</h2>
76
+ <pre><code>uffizzi uffizzi-login-by-identity-token [UFFIZZI_WIDE_FLAG ...]
77
+ </code></pre>
78
+
79
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
80
+ <pre><code>The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline.
81
+ If a user/account do not exist, Uffizzi will create them based on token payload.
82
+
83
+ For more information on authentication and credential types, see:
84
+ https://github.com/UffizziCloud/uffizzi_cli
85
+ </code></pre>
86
+
87
+ <h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
88
+ <pre><code>These flags are available to all commands: --project. Run $ uffizzi
89
+ help for details.
90
+ </code></pre>
91
+
92
+ <h2 id="EXAMPLES">EXAMPLES</h2>
93
+ <pre><code>To login from the CI/CD pipeline, run:
94
+
95
+ $ uffizzi uffizzi-login-by-identity-token --server=uffizzi.example.com --token=[$CI_JOB_TOKEN]
96
+ </code></pre>
97
+
98
+ <ol class='man-decor man-foot man foot'>
99
+ <li class='tl'></li>
100
+ <li class='tc'>August 2022</li>
101
+ <li class='tr'>uffizzi-login-by-identity-token</li>
102
+ </ol>
103
+
104
+ </div>
105
+ </body>
106
+ </html>
data/man/uffizzi-login-by-identity-token.ronn ADDED
@@ -0,0 +1,21 @@
1
+ uffizzi-login-by-identity-token - login to Uffizzi using a OIDC token provided by a CI/CD pipeline
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi uffizzi-login-by-identity-token [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline.
9
+ If a user/account do not exist, Uffizzi will create them based on token payload.
10
+
11
+ For more information on authentication and credential types, see:
12
+ https://docs.uffizzi.com/references/cli/
13
+
14
+ ## UFFIZZI WIDE FLAGS
15
+ These flags are available to all commands: --project. Run $ uffizzi
16
+ help for details.
17
+
18
+ ## EXAMPLES
19
+ To login from the CI/CD pipeline, run:
20
+
21
+ $ uffizzi uffizzi-login-by-identity-token --server=uffizzi.example.com --oidc-token=[$CI_JOB_TOKEN]
data/man/uffizzi-login.html ADDED
@@ -0,0 +1,113 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta http-equiv='content-type' content='text/html;charset=utf8'>
5
+ <meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
6
+ <title>login to Uffizzi to view and manage your previews.</title>
7
+ <style type='text/css' media='all'>
8
+ /* style: man */
9
+ body#manpage {margin:0}
10
+ .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
11
+ .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
12
+ .mp h2 {margin:10px 0 0 0}
13
+ .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
14
+ .mp h3 {margin:0 0 0 4ex}
15
+ .mp dt {margin:0;clear:left}
16
+ .mp dt.flush {float:left;width:8ex}
17
+ .mp dd {margin:0 0 0 9ex}
18
+ .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
19
+ .mp pre {margin-bottom:20px}
20
+ .mp pre+h2,.mp pre+h3 {margin-top:22px}
21
+ .mp h2+pre,.mp h3+pre {margin-top:5px}
22
+ .mp img {display:block;margin:auto}
23
+ .mp h1.man-title {display:none}
24
+ .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
25
+ .mp h2 {font-size:16px;line-height:1.25}
26
+ .mp h1 {font-size:20px;line-height:2}
27
+ .mp {text-align:justify;background:#fff}
28
+ .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
29
+ .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
30
+ .mp u {text-decoration:underline}
31
+ .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
32
+ .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
33
+ .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
34
+ .mp b.man-ref {font-weight:normal;color:#434241}
35
+ .mp pre {padding:0 4ex}
36
+ .mp pre code {font-weight:normal;color:#434241}
37
+ .mp h2+pre,h3+pre {padding-left:0}
38
+ ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
39
+ ol.man-decor {width:100%}
40
+ ol.man-decor li.tl {text-align:left}
41
+ ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42
+ ol.man-decor li.tr {text-align:right;float:right}
43
+ </style>
44
+ </head>
45
+ <!--
46
+ The following styles are deprecated and will be removed at some point:
47
+ div#man, div#man ol.man, div#man ol.head, div#man ol.man.
48
+
49
+ The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
50
+ .man-navigation should be used instead.
51
+ -->
52
+ <body id='manpage'>
53
+ <div class='mp' id='man'>
54
+
55
+ <div class='man-navigation' style='display:none'>
56
+ <a href="#NAME">NAME</a>
57
+ <a href="#SYNOPSIS">SYNOPSIS</a>
58
+ <a href="#DESCRIPTION">DESCRIPTION</a>
59
+ <a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
60
+ <a href="#EXAMPLES">EXAMPLES</a>
61
+ </div>
62
+
63
+ <ol class='man-decor man-head man head'>
64
+ <li class='tl'>uffizzi-login</li>
65
+ <li class='tc'></li>
66
+ <li class='tr'>uffizzi-login</li>
67
+ </ol>
68
+
69
+
70
+
71
+ <h2 id="NAME">NAME</h2>
72
+ <p class="man-name">
73
+ <code>uffizzi-login</code> - <span class="man-whatis">login to Uffizzi to view and manage your previews.</span>
74
+ </p>
75
+ <h2 id="SYNOPSIS">SYNOPSIS</h2>
76
+ <pre><code>uffizzi login [UFFIZZI_WIDE_FLAG ...]
77
+ </code></pre>
78
+
79
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
80
+ <pre><code>The uffizzi login command lets you authenticate with Uffizzi.
81
+
82
+ For more information on authentication and credential types, see:
83
+ https://github.com/UffizziCloud/uffizzi_cli
84
+ </code></pre>
85
+
86
+ <h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
87
+ <pre><code>These flags are available to all commands: --project. Run $ uffizzi
88
+ help for details.
89
+ </code></pre>
90
+
91
+ <h2 id="EXAMPLES">EXAMPLES</h2>
92
+ <pre><code>To login via the browser, run:
93
+
94
+ $ uffizzi login
95
+
96
+ To login to the default host with the default user account, run:
97
+
98
+ $ uffizzi login --email
99
+
100
+ To login to an alternate host, run:
101
+
102
+ $ uffizzi login --server=uffizzi.example.com
103
+ </code></pre>
104
+
105
+ <ol class='man-decor man-foot man foot'>
106
+ <li class='tl'></li>
107
+ <li class='tc'>July 2023</li>
108
+ <li class='tr'>uffizzi-login</li>
109
+ </ol>
110
+
111
+ </div>
112
+ </body>
113
+ </html>
data/man/uffizzi-login.ronn ADDED
@@ -0,0 +1,41 @@
1
+ uffizzi-login - login to Uffizzi to view and manage your previews.
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi login [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ The uffizzi login command lets you authenticate with Uffizzi.
9
+
10
+ For more information on authentication and credential types, see:
11
+ https://docs.uffizzi.com/references/cli/
12
+
13
+ ## FLAGS
14
+ --email
15
+ Login using an email and a password
16
+
17
+ ## OPTIONS
18
+ OPTION is one of the following:
19
+
20
+ --server
21
+ Login with an alternative server.
22
+
23
+ --username
24
+ Login with a username different from the one in the config
25
+
26
+ ## UFFIZZI WIDE FLAGS
27
+ These flags are available to all commands: --project. Run $ uffizzi
28
+ help for details.
29
+
30
+ ## EXAMPLES
31
+ To login via the browser, run:
32
+
33
+ $ uffizzi login
34
+
35
+ To login to the default host with the default user account, run:
36
+
37
+ $ uffizzi login --email
38
+
39
+ To login to an alternate host, run:
40
+
41
+ $ uffizzi login --server=uffizzi.example.com
data/man/uffizzi-logout ADDED
@@ -0,0 +1,21 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-LOGOUT" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-logout\fR \- log out of a Uffizzi user account
6
+ .SH "SYNOPSIS"
7
+ \fBuffizzi logout\fR
8
+ .SH "DESCRIPTION"
9
+ .nf
10
+ The uffizzi logout command logs out of a Uffizzi user account\.
11
+
12
+ For more information on logout, see:
13
+ https://docs\.uffizzi\.com/references/cli/
14
+ .fi
15
+ .SH "UFFIZZI WIDE FLAGS"
16
+ .nf
17
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
18
+ help for details\.
19
+ .fi
20
+ .SH "EXAMPLES"
21
+ uffizzi logout
data/man/uffizzi-logout.ronn ADDED
@@ -0,0 +1,19 @@
1
+ uffizzi-logout - log out of a Uffizzi user account
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+
6
+ `uffizzi logout`
7
+
8
+ ## DESCRIPTION
9
+ The uffizzi logout command logs out of a Uffizzi user account.
10
+
11
+ For more information on logout, see:
12
+ https://docs.uffizzi.com/references/cli/
13
+
14
+ ## UFFIZZI WIDE FLAGS
15
+ These flags are available to all commands: --project. Run $ uffizzi
16
+ help for details.
17
+
18
+ ## EXAMPLES
19
+ uffizzi logout
data/man/uffizzi-preview ADDED
@@ -0,0 +1,39 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\fR \- manage previews
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Manage Uffizzi previews
13
+
14
+ For more information on Uffizzi previews, see:
15
+ https://docs\.uffizzi\.com/references/cli/
16
+ .fi
17
+ .SH "UFFIZZI WIDE FLAGS"
18
+ .nf
19
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
20
+ help for details\.
21
+ .fi
22
+ .SH "COMMANDS"
23
+ .nf
24
+ COMMAND is one of the following:
25
+
26
+ create
27
+ Create a compose environment (preview)
28
+
29
+ delete
30
+ Delete a compose environment (preview)
31
+
32
+ describe
33
+ Display details of a compose environment (preview)
34
+
35
+ list
36
+ List all compose environments (previews)
37
+ .fi
38
+ .SH "Run \'uffizzi compose COMMAND \-\-help\' for more information on a command\."
39
+
data/man/uffizzi-preview-create ADDED
@@ -0,0 +1,67 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE\-CREATE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\-create\fR \- create a compose environment (preview)
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Creates a new compose environment (preview)\. If no COMPOSE_FILE is specified,
13
+ the compose environment (preview) is created with the project\'s default compose file\.
14
+ Run $ uffizzi project compose \-\-help for details\.
15
+
16
+ This command can fail for the following reasons:
17
+ \- The project does not have a default compose file set\. Run
18
+ $ uffizzi compose \-\-help for details\.
19
+ \- The alternate compose file is invalid\.
20
+
21
+ For more information on Uffizzi previews, see:
22
+ https://docs\.uffizzi\.com/references/cli/
23
+ .fi
24
+ .SH "POSITIONAL ARGUMENTS"
25
+ .nf
26
+ [COMPOSE_FILE]
27
+ An alternate compose file to the default compose\.
28
+
29
+ You can pass a compose file to this command to create an ad hoc
30
+ compose environment (preview) of an alternate compose configuration\.
31
+ The file passed via this argument does not replace the default
32
+ compose file for the project\. Alternate compose files share the
33
+ same lifecyle as the previews they create: when the compose
34
+ environment (preview) is deleted, the alternate compose
35
+ is deleted by the Uffizzi API\.
36
+ .fi
37
+ .SH "FLAGS"
38
+ .nf
39
+ \-\-set\-labels=METADATA
40
+ Metadata of deployment that contains any information which can
41
+ be useful for filtering deployments\.
42
+ .fi
43
+ .SH "UFFIZZI WIDE FLAGS"
44
+ .nf
45
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
46
+ help for details\.
47
+ .fi
48
+ .SH "EXAMPLES"
49
+ .nf
50
+ To create a compose environment (preview) with the project\'s default compose file, run:
51
+
52
+ $ uffizzi compose create
53
+
54
+ To create a compose environment (preview) with an alternate compose file, run:
55
+
56
+ $ uffizzi compose create docker\-compose\.uffizzi\.alt\.yml
57
+
58
+ To create a compose environment (preview) with single label, run:
59
+
60
+ $ uffizzi compose create \-\-set\-labels github\.repo=my_repo
61
+
62
+ To create a compose environment (preview) with multiple labels, run:
63
+
64
+ $ uffizzi compose create \e
65
+ \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
66
+ .fi
67
+
data/man/uffizzi-preview-create.ronn ADDED
@@ -0,0 +1,57 @@
1
+ uffizzi-compose-create - create a compose environment (preview)
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Creates a new compose environment (preview). If no COMPOSE_FILE is specified,
9
+ the compose environment (preview) is created with the project's default compose file.
10
+ Run $ uffizzi project compose --help for details.
11
+
12
+ This command can fail for the following reasons:
13
+ - The project does not have a default compose file set. Run
14
+ $ uffizzi compose --help for details.
15
+ - The alternate compose file is invalid.
16
+
17
+ For more information on Uffizzi previews, see:
18
+ https://docs.uffizzi.com/references/cli/
19
+
20
+ ## POSITIONAL ARGUMENTS
21
+ [COMPOSE_FILE]
22
+ An alternate compose file to the default compose.
23
+
24
+ You can pass a compose file to this command to create an ad hoc
25
+ compose environment (preview) of an alternate compose configuration.
26
+ The file passed via this argument does not replace the default
27
+ compose file for the project. Alternate compose files share the
28
+ same lifecyle as the previews they create: when the compose
29
+ environment (preview) is deleted, the alternate compose
30
+ is deleted by the Uffizzi API.
31
+
32
+ ## FLAGS
33
+ --set-labels=METADATA
34
+ Metadata of deployment that contains any information which can
35
+ be useful for filtering deployments.
36
+
37
+ ## UFFIZZI WIDE FLAGS
38
+ These flags are available to all commands: --project. Run $ uffizzi
39
+ help for details.
40
+
41
+ ## EXAMPLES
42
+ To create a compose environment (preview) with the project's default compose file, run:
43
+
44
+ $ uffizzi compose create
45
+
46
+ To create a compose environment (preview) with an alternate compose file, run:
47
+
48
+ $ uffizzi compose create docker-compose.uffizzi.alt.yml
49
+
50
+ To create a compose environment (preview) with single label, run:
51
+
52
+ $ uffizzi compose create --set-labels github.repo=my_repo
53
+
54
+ To create a compose environment (preview) with multiple labels, run:
55
+
56
+ $ uffizzi compose create \
57
+ --set-labels="github.repo=my_repo github.pull_request.number=23"
data/man/uffizzi-preview-delete ADDED
@@ -0,0 +1,38 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE\-DELETE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\-delete\fR \- delete a compose environment (preview)
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Deletes a compose environment (preview) with
13
+ the given compose environment (preview) ID\.
14
+
15
+ This command can fail for the following reasons:
16
+ \- The compose environment (preview) specified does not exist\.
17
+ \- The compose environment (preview) specified belongs to a different project\.
18
+
19
+ For more information on Uffizzi previews, see:
20
+ https://docs\.uffizzi\.com/references/cli/
21
+ .fi
22
+ .SH "POSITIONAL ARGUMENTS"
23
+ .nf
24
+ [PREVIEW_ID]
25
+ ID for the compose environment (preview) you want to delete\.
26
+ .fi
27
+ .SH "UFFIZZI WIDE FLAGS"
28
+ .nf
29
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
30
+ help for details\.
31
+ .fi
32
+ .SH "EXAMPLES"
33
+ .nf
34
+ The following command deletes the compose environment (preview) with ID deployment\-213:
35
+
36
+ $ uffizzi compose delete deployment\-213
37
+ .fi
38
+
data/man/uffizzi-preview-delete.ronn ADDED
@@ -0,0 +1,29 @@
1
+ uffizzi-compose-delete - delete a compose environment (preview)
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Deletes a compose environment (preview) with
9
+ the given compose environment (preview) ID.
10
+
11
+ This command can fail for the following reasons:
12
+ - The compose environment (preview) specified does not exist.
13
+ - The compose environment (preview) specified belongs to a different project.
14
+
15
+ For more information on Uffizzi previews, see:
16
+ https://docs.uffizzi.com/references/cli/
17
+
18
+ ## POSITIONAL ARGUMENTS
19
+ [PREVIEW_ID]
20
+ ID for the compose environment (preview) you want to delete.
21
+
22
+ ## UFFIZZI WIDE FLAGS
23
+ These flags are available to all commands: --project. Run $ uffizzi
24
+ help for details.
25
+
26
+ ## EXAMPLES
27
+ The following command deletes the compose environment (preview) with ID deployment-213:
28
+
29
+ $ uffizzi compose delete deployment-213
data/man/uffizzi-preview-describe ADDED
@@ -0,0 +1,38 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE\-DESCRIBE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\-describe\fR \- show metadata for a compose environment (preview)
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Shows metadata for a project given a valid compose environment (preview) ID\.
13
+
14
+ This command can fail for the following reasons:
15
+ \- The compose environment (preview) specified does not exist\.
16
+ \- The compose environment (preview) specified belongs to a different project\.
17
+
18
+ For more information on Uffizzi previews, see:
19
+ https://docs\.uffizzi\.com/references/cli/
20
+ .fi
21
+ .SH "POSITIONAL ARGUMENTS"
22
+ .nf
23
+ [PREVIEW_ID]
24
+ ID for the compose environment (preview) you want to describe\.
25
+ .fi
26
+ .SH "UFFIZZI WIDE FLAGS"
27
+ .nf
28
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
29
+ help for details\.
30
+ .fi
31
+ .SH "EXAMPLES"
32
+ .nf
33
+ The following command prints metadata for the compose environment (preview) with ID
34
+ deployment\-213:
35
+
36
+ $ uffizzi compose describe deployment\-213
37
+ .fi
38
+
data/man/uffizzi-preview-describe.ronn ADDED
@@ -0,0 +1,29 @@
1
+ uffizzi-compose-describe - show metadata for a compose environment (preview)
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Shows metadata for a project given a valid compose environment (preview) ID.
9
+
10
+ This command can fail for the following reasons:
11
+ - The compose environment (preview) specified does not exist.
12
+ - The compose environment (preview) specified belongs to a different project.
13
+
14
+ For more information on Uffizzi previews, see:
15
+ https://docs.uffizzi.com/references/cli/
16
+
17
+ ## POSITIONAL ARGUMENTS
18
+ [PREVIEW_ID]
19
+ ID for the compose environment (preview) you want to describe.
20
+
21
+ ## UFFIZZI WIDE FLAGS
22
+ These flags are available to all commands: --project. Run $ uffizzi
23
+ help for details.
24
+
25
+ ## EXAMPLES
26
+ The following command prints metadata for the compose environment (preview) with ID
27
+ deployment-213:
28
+
29
+ $ uffizzi compose describe deployment-213