uffizzi-cli 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +4 -0
- data/config/uffizzi.rb +1 -0
- data/lib/uffizzi/cli/common.rb +2 -2
- data/lib/uffizzi/cli/config.rb +3 -3
- data/lib/uffizzi/cli/connect.rb +22 -0
- data/lib/uffizzi/cli/disconnect.rb +3 -0
- data/lib/uffizzi/cli/logout.rb +4 -0
- data/lib/uffizzi/cli/preview/service.rb +2 -2
- data/lib/uffizzi/cli/preview.rb +38 -34
- data/lib/uffizzi/cli/project/compose.rb +2 -2
- data/lib/uffizzi/cli/project/secret.rb +7 -6
- data/lib/uffizzi/cli.rb +28 -9
- data/lib/uffizzi/shell.rb +27 -2
- data/lib/uffizzi/version.rb +1 -1
- data/man/uffizzi +51 -0
- data/man/uffizzi-login +32 -0
- data/man/uffizzi-login.html +113 -0
- data/man/uffizzi-login.ronn +24 -0
- data/man/uffizzi-logout +21 -0
- data/man/uffizzi-logout.html +102 -0
- data/man/uffizzi-logout.ronn +19 -0
- data/man/uffizzi-preview +39 -0
- data/man/uffizzi-preview-create +50 -0
- data/man/uffizzi-preview-create.html +128 -0
- data/man/uffizzi-preview-create.ronn +41 -0
- data/man/uffizzi-preview-delete +37 -0
- data/man/uffizzi-preview-delete.html +115 -0
- data/man/uffizzi-preview-delete.ronn +28 -0
- data/man/uffizzi-preview-describe +38 -0
- data/man/uffizzi-preview-describe.html +116 -0
- data/man/uffizzi-preview-describe.ronn +29 -0
- data/man/uffizzi-preview-events +37 -0
- data/man/uffizzi-preview-events.html +110 -0
- data/man/uffizzi-preview-events.ronn +28 -0
- data/man/uffizzi-preview-list +33 -0
- data/man/uffizzi-preview-list.html +110 -0
- data/man/uffizzi-preview-list.ronn +25 -0
- data/man/uffizzi-preview-service-list +38 -0
- data/man/uffizzi-preview-service-list.ronn +29 -0
- data/man/uffizzi-preview-service-logs +57 -0
- data/man/uffizzi-preview-service-logs.ronn +47 -0
- data/man/uffizzi-preview.html +120 -0
- data/man/uffizzi-preview.ronn +33 -0
- data/man/uffizzi-preview_service_logs +57 -0
- data/man/uffizzi-preview_service_logs.html +142 -0
- data/man/uffizzi-preview_service_logs.ronn +49 -0
- data/man/uffizzi-project +47 -0
- data/man/uffizzi-project-compose +40 -0
- data/man/uffizzi-project-compose-describe +37 -0
- data/man/uffizzi-project-compose-describe.html +118 -0
- data/man/uffizzi-project-compose-describe.ronn +29 -0
- data/man/uffizzi-project-compose-set +66 -0
- data/man/uffizzi-project-compose-set.html +149 -0
- data/man/uffizzi-project-compose-set.ronn +57 -0
- data/man/uffizzi-project-compose-unset +35 -0
- data/man/uffizzi-project-compose-unset.html +116 -0
- data/man/uffizzi-project-compose-unset.ronn +27 -0
- data/man/uffizzi-project-compose.html +123 -0
- data/man/uffizzi-project-compose.ronn +34 -0
- data/man/uffizzi-project-secret +37 -0
- data/man/uffizzi-project-secret-create +29 -0
- data/man/uffizzi-project-secret-create.html +110 -0
- data/man/uffizzi-project-secret-create.ronn +21 -0
- data/man/uffizzi-project-secret-delete +29 -0
- data/man/uffizzi-project-secret-delete.html +110 -0
- data/man/uffizzi-project-secret-delete.ronn +21 -0
- data/man/uffizzi-project-secret-list +28 -0
- data/man/uffizzi-project-secret-list.html +110 -0
- data/man/uffizzi-project-secret-list.ronn +20 -0
- data/man/uffizzi-project-secret.html +119 -0
- data/man/uffizzi-project-secret.ronn +30 -0
- data/man/uffizzi-project.html +128 -0
- data/man/uffizzi-project.ronn +41 -0
- data/man/uffizzi.html +132 -0
- data/man/uffizzi.ronn +43 -0
- metadata +63 -2
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" "" "March 2022" ""
|
|
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
|
|
@@ -0,0 +1,102 @@
|
|
|
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>log out of a Uffizzi user account</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-logout</li>
|
|
65
|
+
<li class='tc'></li>
|
|
66
|
+
<li class='tr'>uffizzi-logout</li>
|
|
67
|
+
</ol>
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
<h2 id="NAME">NAME</h2>
|
|
72
|
+
<p class="man-name">
|
|
73
|
+
<code>uffizzi-logout</code> - <span class="man-whatis">log out of a Uffizzi user account</span>
|
|
74
|
+
</p>
|
|
75
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
|
76
|
+
|
|
77
|
+
<p><code>uffizzi logout</code></p>
|
|
78
|
+
|
|
79
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
80
|
+
<pre><code>The uffizzi logout command logs out of a Uffizzi user account.
|
|
81
|
+
|
|
82
|
+
For more information on logout, see:
|
|
83
|
+
https://docs.uffizzi.com/references/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
|
+
<p>uffizzi logout</p>
|
|
93
|
+
|
|
94
|
+
<ol class='man-decor man-foot man foot'>
|
|
95
|
+
<li class='tl'></li>
|
|
96
|
+
<li class='tc'>March 2022</li>
|
|
97
|
+
<li class='tr'>uffizzi-logout</li>
|
|
98
|
+
</ol>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
</body>
|
|
102
|
+
</html>
|
|
@@ -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\-PREVIEW" "" "April 2022" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-preview\fR \- manage previews
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
.nf
|
|
8
|
+
uffizzi preview 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/cli/preview
|
|
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 preview
|
|
28
|
+
|
|
29
|
+
delete
|
|
30
|
+
Delete a preview
|
|
31
|
+
|
|
32
|
+
describe
|
|
33
|
+
Display details of a preview
|
|
34
|
+
|
|
35
|
+
list
|
|
36
|
+
List all previews
|
|
37
|
+
.fi
|
|
38
|
+
.SH "Run \'uffizzi preview COMMAND \-\-help\' for more information on a command\."
|
|
39
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
3
|
+
.TH "UFFIZZI\-PREVIEW\-CREATE" "" "April 2022" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-preview\-create\fR \- create a preview
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
.nf
|
|
8
|
+
uffizzi preview create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
|
9
|
+
.fi
|
|
10
|
+
.SH "DESCRIPTION"
|
|
11
|
+
.nf
|
|
12
|
+
Creates a new preview\. If no COMPOSE_FILE is specified, the preview
|
|
13
|
+
is created with the project\'s default compose file\.
|
|
14
|
+
|
|
15
|
+
This command can fail for the following reasons:
|
|
16
|
+
\- The project does not have a default compose file set\. Run
|
|
17
|
+
$ uffizzi compose \-\-help for details\.
|
|
18
|
+
\- The alternate compose file is invalid\.
|
|
19
|
+
|
|
20
|
+
For more information on Uffizzi previews, see:
|
|
21
|
+
https://docs\.uffizzi\.com/cli/preview
|
|
22
|
+
.fi
|
|
23
|
+
.SH "POSITIONAL ARGUMENTS"
|
|
24
|
+
.nf
|
|
25
|
+
[COMPOSE_FILE]
|
|
26
|
+
An alternate compose file to the default compose\.
|
|
27
|
+
|
|
28
|
+
You can pass a compose file to this command to create an ad hoc
|
|
29
|
+
preview of an alternate compose configuration\. The file passed
|
|
30
|
+
via this argument does not replace the default compose file for
|
|
31
|
+
the project\. Alternate compose files share the same lifecyle as
|
|
32
|
+
the previews they create: when the preview is deleted, the
|
|
33
|
+
alternate compose is deleted by the Uffizzi API\.
|
|
34
|
+
.fi
|
|
35
|
+
.SH "UFFIZZI WIDE FLAGS"
|
|
36
|
+
.nf
|
|
37
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
|
38
|
+
help for details\.
|
|
39
|
+
.fi
|
|
40
|
+
.SH "EXAMPLES"
|
|
41
|
+
.nf
|
|
42
|
+
To create a preview with the project\'s default compose file, run:
|
|
43
|
+
|
|
44
|
+
$ uffizzi preview create
|
|
45
|
+
|
|
46
|
+
To create a preview with an alternate compose file, run:
|
|
47
|
+
|
|
48
|
+
$ uffizzi preview create docker\-compose\.uffizzi\.alt\.yml
|
|
49
|
+
.fi
|
|
50
|
+
|
|
@@ -0,0 +1,128 @@
|
|
|
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>create a preview</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="#POSITIONAL-ARGUMENTS">POSITIONAL ARGUMENTS</a>
|
|
60
|
+
<a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
|
|
61
|
+
<a href="#EXAMPLES">EXAMPLES</a>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<ol class='man-decor man-head man head'>
|
|
65
|
+
<li class='tl'>create</li>
|
|
66
|
+
<li class='tc'></li>
|
|
67
|
+
<li class='tr'>create</li>
|
|
68
|
+
</ol>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<h2 id="NAME">NAME</h2>
|
|
73
|
+
<p class="man-name">
|
|
74
|
+
<code>create</code> - <span class="man-whatis">create a preview</span>
|
|
75
|
+
</p>
|
|
76
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
|
77
|
+
<pre><code>uffizzi preview create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
|
|
78
|
+
</code></pre>
|
|
79
|
+
|
|
80
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
81
|
+
<pre><code>Creates a new preview. If no COMPOSE_FILE is specified, the preview
|
|
82
|
+
is created with the project's default compose file.
|
|
83
|
+
|
|
84
|
+
This command can fail for the following reasons:
|
|
85
|
+
- The project does not have a default compose file set. Run
|
|
86
|
+
$ uffizzi compose --help for details.
|
|
87
|
+
- The alternate compose file is invalid.
|
|
88
|
+
|
|
89
|
+
For more information on Uffizzi previews, see:
|
|
90
|
+
https://docs.uffizzi.com/cli/preview
|
|
91
|
+
</code></pre>
|
|
92
|
+
|
|
93
|
+
<h2 id="POSITIONAL-ARGUMENTS">POSITIONAL ARGUMENTS</h2>
|
|
94
|
+
<pre><code>[COMPOSE_FILE]
|
|
95
|
+
An alternate compose file to the default compose.
|
|
96
|
+
|
|
97
|
+
You can pass a compose file to this command to create an ad hoc
|
|
98
|
+
preview of an alternate compose configuration. The file passed
|
|
99
|
+
via this argument does not replace the default compose file for
|
|
100
|
+
the project. Alternate compose files share the same lifecyle as
|
|
101
|
+
the previews they create: when the preview is deleted, the
|
|
102
|
+
alternate compose is deleted by the Uffizzi API.
|
|
103
|
+
</code></pre>
|
|
104
|
+
|
|
105
|
+
<h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
|
|
106
|
+
<pre><code>These flags are available to all commands: --project. Run $ uffizzi
|
|
107
|
+
help for details.
|
|
108
|
+
</code></pre>
|
|
109
|
+
|
|
110
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
111
|
+
<pre><code>To create a preview with the project's default compose file, run:
|
|
112
|
+
|
|
113
|
+
$ uffizzi preview create
|
|
114
|
+
|
|
115
|
+
To create a preview with an alternate compose file, run:
|
|
116
|
+
|
|
117
|
+
$ uffizzi preview create docker-compose.uffizzi.alt.yml
|
|
118
|
+
</code></pre>
|
|
119
|
+
|
|
120
|
+
<ol class='man-decor man-foot man foot'>
|
|
121
|
+
<li class='tl'></li>
|
|
122
|
+
<li class='tc'>March 2022</li>
|
|
123
|
+
<li class='tr'>create</li>
|
|
124
|
+
</ol>
|
|
125
|
+
|
|
126
|
+
</div>
|
|
127
|
+
</body>
|
|
128
|
+
</html>
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
uffizzi-preview-create - create a preview
|
|
2
|
+
================================================================
|
|
3
|
+
|
|
4
|
+
## SYNOPSIS
|
|
5
|
+
uffizzi preview create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
|
|
6
|
+
|
|
7
|
+
## DESCRIPTION
|
|
8
|
+
Creates a new preview. If no COMPOSE_FILE is specified, the preview
|
|
9
|
+
is created with the project's default compose file.
|
|
10
|
+
|
|
11
|
+
This command can fail for the following reasons:
|
|
12
|
+
- The project does not have a default compose file set. Run
|
|
13
|
+
$ uffizzi compose --help for details.
|
|
14
|
+
- The alternate compose file is invalid.
|
|
15
|
+
|
|
16
|
+
For more information on Uffizzi previews, see:
|
|
17
|
+
https://docs.uffizzi.com/cli/preview
|
|
18
|
+
|
|
19
|
+
## POSITIONAL ARGUMENTS
|
|
20
|
+
[COMPOSE_FILE]
|
|
21
|
+
An alternate compose file to the default compose.
|
|
22
|
+
|
|
23
|
+
You can pass a compose file to this command to create an ad hoc
|
|
24
|
+
preview of an alternate compose configuration. The file passed
|
|
25
|
+
via this argument does not replace the default compose file for
|
|
26
|
+
the project. Alternate compose files share the same lifecyle as
|
|
27
|
+
the previews they create: when the preview is deleted, the
|
|
28
|
+
alternate compose is deleted by the Uffizzi API.
|
|
29
|
+
|
|
30
|
+
## UFFIZZI WIDE FLAGS
|
|
31
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
|
32
|
+
help for details.
|
|
33
|
+
|
|
34
|
+
## EXAMPLES
|
|
35
|
+
To create a preview with the project's default compose file, run:
|
|
36
|
+
|
|
37
|
+
$ uffizzi preview create
|
|
38
|
+
|
|
39
|
+
To create a preview with an alternate compose file, run:
|
|
40
|
+
|
|
41
|
+
$ uffizzi preview create docker-compose.uffizzi.alt.yml
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
3
|
+
.TH "UFFIZZI\-PREVIEW\-DELETE" "" "April 2022" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-preview\-delete\fR \- delete a preview
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
.nf
|
|
8
|
+
uffizzi preview delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
|
9
|
+
.fi
|
|
10
|
+
.SH "DESCRIPTION"
|
|
11
|
+
.nf
|
|
12
|
+
Deletes a preview with the given preview ID\.
|
|
13
|
+
|
|
14
|
+
This command can fail for the following reasons:
|
|
15
|
+
\- The preview specified does not exist\.
|
|
16
|
+
\- The preview specified belongs to a different project\.
|
|
17
|
+
|
|
18
|
+
For more information on Uffizzi previews, see:
|
|
19
|
+
https://docs\.uffizzi\.com/cli/preview
|
|
20
|
+
.fi
|
|
21
|
+
.SH "POSITIONAL ARGUMENTS"
|
|
22
|
+
.nf
|
|
23
|
+
[PREVIEW_ID]
|
|
24
|
+
ID for the preview you want to delete\.
|
|
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 deletes the preview with ID deployment\-213:
|
|
34
|
+
|
|
35
|
+
$ uffizzi preview delete deployment\-213
|
|
36
|
+
.fi
|
|
37
|
+
|
|
@@ -0,0 +1,115 @@
|
|
|
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>delete a preview</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="#POSITIONAL-ARGUMENTS">POSITIONAL ARGUMENTS</a>
|
|
60
|
+
<a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
|
|
61
|
+
<a href="#EXAMPLES">EXAMPLES</a>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<ol class='man-decor man-head man head'>
|
|
65
|
+
<li class='tl'>delete</li>
|
|
66
|
+
<li class='tc'></li>
|
|
67
|
+
<li class='tr'>delete</li>
|
|
68
|
+
</ol>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<h2 id="NAME">NAME</h2>
|
|
73
|
+
<p class="man-name">
|
|
74
|
+
<code>delete</code> - <span class="man-whatis">delete a preview</span>
|
|
75
|
+
</p>
|
|
76
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
|
77
|
+
<pre><code>uffizzi preview delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
|
|
78
|
+
</code></pre>
|
|
79
|
+
|
|
80
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
81
|
+
<pre><code>Deletes a preview with the given preview ID.
|
|
82
|
+
|
|
83
|
+
This command can fail for the following reasons:
|
|
84
|
+
- The preview specified does not exist.
|
|
85
|
+
- The preview specified belongs to a different project.
|
|
86
|
+
|
|
87
|
+
For more information on Uffizzi previews, see:
|
|
88
|
+
https://docs.uffizzi.com/cli/preview
|
|
89
|
+
</code></pre>
|
|
90
|
+
|
|
91
|
+
<h2 id="POSITIONAL-ARGUMENTS">POSITIONAL ARGUMENTS</h2>
|
|
92
|
+
<pre><code>[PREVIEW_ID]
|
|
93
|
+
ID for the preview you want to delete.
|
|
94
|
+
</code></pre>
|
|
95
|
+
|
|
96
|
+
<h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
|
|
97
|
+
<pre><code>These flags are available to all commands: --project. Run $ uffizzi
|
|
98
|
+
help for details.
|
|
99
|
+
</code></pre>
|
|
100
|
+
|
|
101
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
102
|
+
<pre><code>The following command deletes the preview with ID deployment-213:
|
|
103
|
+
|
|
104
|
+
$ uffizzi preview delete deployment-213
|
|
105
|
+
</code></pre>
|
|
106
|
+
|
|
107
|
+
<ol class='man-decor man-foot man foot'>
|
|
108
|
+
<li class='tl'></li>
|
|
109
|
+
<li class='tc'>March 2022</li>
|
|
110
|
+
<li class='tr'>delete</li>
|
|
111
|
+
</ol>
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
</body>
|
|
115
|
+
</html>
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
uffizzi-preview-delete - delete a preview
|
|
2
|
+
================================================================
|
|
3
|
+
|
|
4
|
+
## SYNOPSIS
|
|
5
|
+
uffizzi preview delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
|
|
6
|
+
|
|
7
|
+
## DESCRIPTION
|
|
8
|
+
Deletes a preview with the given preview ID.
|
|
9
|
+
|
|
10
|
+
This command can fail for the following reasons:
|
|
11
|
+
- The preview specified does not exist.
|
|
12
|
+
- The preview specified belongs to a different project.
|
|
13
|
+
|
|
14
|
+
For more information on Uffizzi previews, see:
|
|
15
|
+
https://docs.uffizzi.com/cli/preview
|
|
16
|
+
|
|
17
|
+
## POSITIONAL ARGUMENTS
|
|
18
|
+
[PREVIEW_ID]
|
|
19
|
+
ID for the preview you want to delete.
|
|
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 deletes the preview with ID deployment-213:
|
|
27
|
+
|
|
28
|
+
$ uffizzi preview delete deployment-213
|
|
@@ -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\-PREVIEW\-DESCRIBE" "" "April 2022" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-preview\-describe\fR \- show metadata for a preview
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
.nf
|
|
8
|
+
uffizzi preview describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
|
9
|
+
.fi
|
|
10
|
+
.SH "DESCRIPTION"
|
|
11
|
+
.nf
|
|
12
|
+
Shows metadata for a project given a valid preview ID\.
|
|
13
|
+
|
|
14
|
+
This command can fail for the following reasons:
|
|
15
|
+
\- The preview specified does not exist\.
|
|
16
|
+
\- The preview specified belongs to a different project\.
|
|
17
|
+
|
|
18
|
+
For more information on Uffizzi previews, see:
|
|
19
|
+
https://docs\.uffizzi\.com/cli/preview
|
|
20
|
+
.fi
|
|
21
|
+
.SH "POSITIONAL ARGUMENTS"
|
|
22
|
+
.nf
|
|
23
|
+
[PREVIEW_ID]
|
|
24
|
+
ID for the 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 preview with ID
|
|
34
|
+
deployment\-213:
|
|
35
|
+
|
|
36
|
+
$ uffizzi preview describe deployment\-213
|
|
37
|
+
.fi
|
|
38
|
+
|