uffizzi-cli 0.4.0 → 0.5.2
Sign up to get free protection for your applications and to get access to all the features.
- 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 +40 -36
- 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/clients/api/api_client.rb +2 -0
- data/lib/uffizzi/clients/api/http_client.rb +1 -3
- data/lib/uffizzi/shell.rb +32 -1
- data/lib/uffizzi/version.rb +1 -1
- data/lib/uffizzi.rb +4 -0
- 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 +77 -2
@@ -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\-PROJECT\-COMPOSE\-DESCRIBE" "" "April 2022" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-project\-compose\-describe\fR \- show metadata for a compose file
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi project compose describe [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
By default, shows the contents of the default project’s compose
|
13
|
+
file\. Use the \-\-project flag to describe the compose file of a
|
14
|
+
different project\.
|
15
|
+
|
16
|
+
This command can fail for the following reasons:
|
17
|
+
\- A compose file is not set for the project\.
|
18
|
+
|
19
|
+
For more information on the uffizzi project compose command, see:
|
20
|
+
https://docs\.uffizzi\.com/cli/project
|
21
|
+
|
22
|
+
For more information on the Uffizzi Compose specification, see:
|
23
|
+
https://docs\.uffizzi\.com/references/compose\-spec
|
24
|
+
.fi
|
25
|
+
.SH "UFFIZZI WIDE FLAGS"
|
26
|
+
.nf
|
27
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
28
|
+
help for details\.
|
29
|
+
.fi
|
30
|
+
.SH "EXAMPLES"
|
31
|
+
.nf
|
32
|
+
The following command prints the contents of the default project’s
|
33
|
+
compose file:
|
34
|
+
|
35
|
+
$ uffizzi project compose describe
|
36
|
+
.fi
|
37
|
+
|
@@ -0,0 +1,118 @@
|
|
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>uffizzi-project-compose-describe</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="#NAME">NAME</a>
|
58
|
+
<a href="#SYNOPSIS">SYNOPSIS</a>
|
59
|
+
<a href="#DESCRIPTION">DESCRIPTION</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'>uffizzi-project-compose-describe</li>
|
66
|
+
<li class='tc'></li>
|
67
|
+
<li class='tr'>uffizzi-project-compose-describe</li>
|
68
|
+
</ol>
|
69
|
+
|
70
|
+
|
71
|
+
<h2 id="NAME">NAME</h2>
|
72
|
+
<p class="man-name">
|
73
|
+
<code>uffizzi-project-compose-describe</code>
|
74
|
+
</p>
|
75
|
+
<h2 id="NAME">NAME</h2>
|
76
|
+
<pre><code>uffizzi project compose describe - show metadata for a compose file
|
77
|
+
</code></pre>
|
78
|
+
|
79
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
80
|
+
<pre><code>uffizzi project compose describe [UFFIZZI_WIDE_FLAG ...]
|
81
|
+
</code></pre>
|
82
|
+
|
83
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
84
|
+
<pre><code>By default, shows the contents of the default project’s compose
|
85
|
+
file. Use the --project flag to describe the compose file of a
|
86
|
+
different project.
|
87
|
+
|
88
|
+
This command can fail for the following reasons:
|
89
|
+
- A compose file is not set for the project.
|
90
|
+
|
91
|
+
For more information on the uffizzi project compose command, see:
|
92
|
+
https://docs.uffizzi.com/cli/project
|
93
|
+
|
94
|
+
For more information on the Uffizzi Compose specification, see:
|
95
|
+
https://docs.uffizzi.com/references/compose-spec
|
96
|
+
</code></pre>
|
97
|
+
|
98
|
+
<h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
|
99
|
+
<pre><code>These flags are available to all commands: --project. Run $ uffizzi
|
100
|
+
help for details.
|
101
|
+
</code></pre>
|
102
|
+
|
103
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
104
|
+
<pre><code>The following command prints the contents of the default project’s
|
105
|
+
compose file:
|
106
|
+
|
107
|
+
$ uffizzi project compose describe
|
108
|
+
</code></pre>
|
109
|
+
|
110
|
+
<ol class='man-decor man-foot man foot'>
|
111
|
+
<li class='tl'></li>
|
112
|
+
<li class='tc'>March 2022</li>
|
113
|
+
<li class='tr'>uffizzi-project-compose-describe</li>
|
114
|
+
</ol>
|
115
|
+
|
116
|
+
</div>
|
117
|
+
</body>
|
118
|
+
</html>
|
@@ -0,0 +1,29 @@
|
|
1
|
+
uffizzi-project-compose-describe - show metadata for a compose file
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi project compose describe [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
By default, shows the contents of the default project’s compose
|
9
|
+
file. Use the --project flag to describe the compose file of a
|
10
|
+
different project.
|
11
|
+
|
12
|
+
This command can fail for the following reasons:
|
13
|
+
- A compose file is not set for the project.
|
14
|
+
|
15
|
+
For more information on the uffizzi project compose command, see:
|
16
|
+
https://docs.uffizzi.com/cli/project
|
17
|
+
|
18
|
+
For more information on the Uffizzi Compose specification, see:
|
19
|
+
https://docs.uffizzi.com/references/compose-spec
|
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 the contents of the default project’s
|
27
|
+
compose file:
|
28
|
+
|
29
|
+
$ uffizzi project compose describe
|
@@ -0,0 +1,66 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-PROJECT\-COMPOSE\-SET" "" "April 2022" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-project\-compose\-set\fR \- sets the configuration of a project with a compose file
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi project compose set [\-\-repository=REPOSITORY]
|
9
|
+
[\-\-branch=BRANCH] [\-\-path=PATH_TO_COMPOSE_FILE]
|
10
|
+
[UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
11
|
+
.fi
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
.nf
|
14
|
+
By default, sets the configuration of the default project with the
|
15
|
+
specified compose file\. Use the \-\-project flag to set the compose
|
16
|
+
file of a different project\. If already set, this command overrides
|
17
|
+
the project\'s configuration with the new compose file\. The compose
|
18
|
+
file must exist within a GitHub repository\.
|
19
|
+
|
20
|
+
This command can fail for the following reasons:
|
21
|
+
\- The repository, branch, or path to the compose file as
|
22
|
+
specified does not exist\.
|
23
|
+
\- uffizzi is not authorized to access the repository\.
|
24
|
+
Run $ uffizzi connect \-\-help for details about connecting to
|
25
|
+
external services\.
|
26
|
+
\- The compose file is invalid\.
|
27
|
+
|
28
|
+
For more information on the uffizzi project compose command, see:
|
29
|
+
https://docs\.uffizzi\.com/cli/project
|
30
|
+
|
31
|
+
For more information on the Uffizzi Compose specification, see:
|
32
|
+
https://docs\.uffizzi\.com/references/compose\-spec
|
33
|
+
.fi
|
34
|
+
.SH "FLAGS"
|
35
|
+
.nf
|
36
|
+
\-\-repository=REPOSITORY
|
37
|
+
The repository that contains the compose file you want to set
|
38
|
+
for a project\.
|
39
|
+
|
40
|
+
\-\-branch=BRANCH
|
41
|
+
The branch of the repository that contains the compose file you
|
42
|
+
want to set for a project\. If not specified, the default branch
|
43
|
+
as configured on GitHub is used\.
|
44
|
+
|
45
|
+
\-\-path=PATH_TO_COMPOSE_FILE
|
46
|
+
The path to the compose file that you want to set for a project\.
|
47
|
+
This compose file is used as the default when creating previews\.
|
48
|
+
Run $ uffizzi preview \-\-help for details\.
|
49
|
+
.fi
|
50
|
+
.SH "UFFIZZI WIDE FLAGS"
|
51
|
+
.nf
|
52
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
53
|
+
help for details\.
|
54
|
+
.fi
|
55
|
+
.SH "EXAMPLES"
|
56
|
+
.nf
|
57
|
+
The following command sets a compose file for the default project\.
|
58
|
+
The compose file (docker\-compose\.uffizzi\.yml) exists in the main
|
59
|
+
branch of a GitHub repository called example\-app:
|
60
|
+
|
61
|
+
$ uffizzi project compose set \e
|
62
|
+
\-\-repository="github\.com/example/example\-app" \e
|
63
|
+
\-\-branch="main" \e
|
64
|
+
\-\-path="app/docker\-compose\.uffizzi\.yml"
|
65
|
+
.fi
|
66
|
+
|
@@ -0,0 +1,149 @@
|
|
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>uffizzi-project-compose-set</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="#NAME">NAME</a>
|
58
|
+
<a href="#SYNOPSIS">SYNOPSIS</a>
|
59
|
+
<a href="#DESCRIPTION">DESCRIPTION</a>
|
60
|
+
<a href="#FLAGS">FLAGS</a>
|
61
|
+
<a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
|
62
|
+
<a href="#EXAMPLES">EXAMPLES</a>
|
63
|
+
</div>
|
64
|
+
|
65
|
+
<ol class='man-decor man-head man head'>
|
66
|
+
<li class='tl'>uffizzi-project-compose-set</li>
|
67
|
+
<li class='tc'></li>
|
68
|
+
<li class='tr'>uffizzi-project-compose-set</li>
|
69
|
+
</ol>
|
70
|
+
|
71
|
+
|
72
|
+
<h2 id="NAME">NAME</h2>
|
73
|
+
<p class="man-name">
|
74
|
+
<code>uffizzi-project-compose-set</code>
|
75
|
+
</p>
|
76
|
+
<h2 id="NAME">NAME</h2>
|
77
|
+
<pre><code>uffizzi project compose set - Sets the configuration of a project
|
78
|
+
with a compose file
|
79
|
+
</code></pre>
|
80
|
+
|
81
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
82
|
+
<pre><code>uffizzi project compose set [--repository=REPOSITORY]
|
83
|
+
[--branch=BRANCH] [--path=PATH_TO_COMPOSE_FILE]
|
84
|
+
[UFFIZZI_WIDE_FLAG ...]
|
85
|
+
</code></pre>
|
86
|
+
|
87
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
88
|
+
<pre><code>By default, sets the configuration of the default project with the
|
89
|
+
specified compose file. Use the --project flag to set the compose
|
90
|
+
file of a different project. If already set, this command overrides
|
91
|
+
the project's configuration with the new compose file. The compose
|
92
|
+
file must exist within a GitHub repository.
|
93
|
+
|
94
|
+
This command can fail for the following reasons:
|
95
|
+
- The repository, branch, or path to the compose file as
|
96
|
+
specified does not exist.
|
97
|
+
- uffizzi is not authorized to access the repository.
|
98
|
+
Run $ uffizzi connect --help for details about connecting to
|
99
|
+
external services.
|
100
|
+
- The compose file is invalid.
|
101
|
+
|
102
|
+
For more information on the uffizzi project compose command, see:
|
103
|
+
https://docs.uffizzi.com/cli/project
|
104
|
+
|
105
|
+
For more information on the Uffizzi Compose specification, see:
|
106
|
+
https://docs.uffizzi.com/references/compose-spec
|
107
|
+
</code></pre>
|
108
|
+
|
109
|
+
<h2 id="FLAGS">FLAGS</h2>
|
110
|
+
<pre><code>--repository=REPOSITORY
|
111
|
+
The repository that contains the compose file you want to set
|
112
|
+
for a project.
|
113
|
+
|
114
|
+
--branch=BRANCH
|
115
|
+
The branch of the repository that contains the compose file you
|
116
|
+
want to set for a project. If not specified, the default branch
|
117
|
+
as configured on GitHub is used.
|
118
|
+
|
119
|
+
--path=PATH_TO_COMPOSE_FILE
|
120
|
+
The path to the compose file that you want to set for a project.
|
121
|
+
This compose file is used as the default when creating previews.
|
122
|
+
Run $ uffizzi preview --help for details.
|
123
|
+
</code></pre>
|
124
|
+
|
125
|
+
<h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
|
126
|
+
<pre><code>These flags are available to all commands: --project. Run $ uffizzi
|
127
|
+
help for details.
|
128
|
+
</code></pre>
|
129
|
+
|
130
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
131
|
+
<pre><code>The following command sets a compose file for the default project.
|
132
|
+
The compose file (docker-compose.uffizzi.yml) exists in the main
|
133
|
+
branch of a GitHub repository called example-app:
|
134
|
+
|
135
|
+
$ uffizzi project compose set \
|
136
|
+
--repository="github.com/example/example-app" \
|
137
|
+
--branch="main" \
|
138
|
+
--path="app/docker-compose.uffizzi.yml"
|
139
|
+
</code></pre>
|
140
|
+
|
141
|
+
<ol class='man-decor man-foot man foot'>
|
142
|
+
<li class='tl'></li>
|
143
|
+
<li class='tc'>March 2022</li>
|
144
|
+
<li class='tr'>uffizzi-project-compose-set</li>
|
145
|
+
</ol>
|
146
|
+
|
147
|
+
</div>
|
148
|
+
</body>
|
149
|
+
</html>
|
@@ -0,0 +1,57 @@
|
|
1
|
+
uffizzi-project-compose-set - sets the configuration of a project with a compose file
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi project compose set [--repository=REPOSITORY]
|
6
|
+
[--branch=BRANCH] [--path=PATH_TO_COMPOSE_FILE]
|
7
|
+
[UFFIZZI_WIDE_FLAG ...]
|
8
|
+
|
9
|
+
## DESCRIPTION
|
10
|
+
By default, sets the configuration of the default project with the
|
11
|
+
specified compose file. Use the --project flag to set the compose
|
12
|
+
file of a different project. If already set, this command overrides
|
13
|
+
the project's configuration with the new compose file. The compose
|
14
|
+
file must exist within a GitHub repository.
|
15
|
+
|
16
|
+
This command can fail for the following reasons:
|
17
|
+
- The repository, branch, or path to the compose file as
|
18
|
+
specified does not exist.
|
19
|
+
- uffizzi is not authorized to access the repository.
|
20
|
+
Run $ uffizzi connect --help for details about connecting to
|
21
|
+
external services.
|
22
|
+
- The compose file is invalid.
|
23
|
+
|
24
|
+
For more information on the uffizzi project compose command, see:
|
25
|
+
https://docs.uffizzi.com/cli/project
|
26
|
+
|
27
|
+
For more information on the Uffizzi Compose specification, see:
|
28
|
+
https://docs.uffizzi.com/references/compose-spec
|
29
|
+
|
30
|
+
## FLAGS
|
31
|
+
--repository=REPOSITORY
|
32
|
+
The repository that contains the compose file you want to set
|
33
|
+
for a project.
|
34
|
+
|
35
|
+
--branch=BRANCH
|
36
|
+
The branch of the repository that contains the compose file you
|
37
|
+
want to set for a project. If not specified, the default branch
|
38
|
+
as configured on GitHub is used.
|
39
|
+
|
40
|
+
--path=PATH_TO_COMPOSE_FILE
|
41
|
+
The path to the compose file that you want to set for a project.
|
42
|
+
This compose file is used as the default when creating previews.
|
43
|
+
Run $ uffizzi preview --help for details.
|
44
|
+
|
45
|
+
## UFFIZZI WIDE FLAGS
|
46
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
47
|
+
help for details.
|
48
|
+
|
49
|
+
## EXAMPLES
|
50
|
+
The following command sets a compose file for the default project.
|
51
|
+
The compose file (docker-compose.uffizzi.yml) exists in the main
|
52
|
+
branch of a GitHub repository called example-app:
|
53
|
+
|
54
|
+
$ uffizzi project compose set \
|
55
|
+
--repository="github.com/example/example-app" \
|
56
|
+
--branch="main" \
|
57
|
+
--path="app/docker-compose.uffizzi.yml"
|
@@ -0,0 +1,35 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-PROJECT\-COMPOSE\-UNSET" "" "April 2022" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-project\-compose\-unset\fR \- unset the compose file for a project
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi project compose unset [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
By default, unsets the compose file for the default project\. Use the
|
13
|
+
\-\-project flag to unset the compose file of a different project\.
|
14
|
+
|
15
|
+
This command can fail for the following reasons:
|
16
|
+
\- A compose file is not set for the project\.
|
17
|
+
|
18
|
+
For more information on the uffizzi project compose command, see:
|
19
|
+
https://docs\.uffizzi\.com/cli/project
|
20
|
+
|
21
|
+
For more information on the Uffizzi Compose specification, see:
|
22
|
+
https://docs\.uffizzi\.com/references/compose\-spec
|
23
|
+
.fi
|
24
|
+
.SH "UFFIZZI WIDE FLAGS"
|
25
|
+
.nf
|
26
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
27
|
+
help for details\.
|
28
|
+
.fi
|
29
|
+
.SH "EXAMPLES"
|
30
|
+
.nf
|
31
|
+
The following command unsets the default project’s compose file:
|
32
|
+
|
33
|
+
$ uffizzi project compose unset
|
34
|
+
.fi
|
35
|
+
|
@@ -0,0 +1,116 @@
|
|
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>uffizzi-project-compose-unset</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="#NAME">NAME</a>
|
58
|
+
<a href="#SYNOPSIS">SYNOPSIS</a>
|
59
|
+
<a href="#DESCRIPTION">DESCRIPTION</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'>uffizzi-project-compose-unset</li>
|
66
|
+
<li class='tc'></li>
|
67
|
+
<li class='tr'>uffizzi-project-compose-unset</li>
|
68
|
+
</ol>
|
69
|
+
|
70
|
+
|
71
|
+
<h2 id="NAME">NAME</h2>
|
72
|
+
<p class="man-name">
|
73
|
+
<code>uffizzi-project-compose-unset</code>
|
74
|
+
</p>
|
75
|
+
<h2 id="NAME">NAME</h2>
|
76
|
+
<pre><code>uffizzi project compose unset - unset the compose file for a project
|
77
|
+
</code></pre>
|
78
|
+
|
79
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
80
|
+
<pre><code>uffizzi project compose unset [UFFIZZI_WIDE_FLAG ...]
|
81
|
+
</code></pre>
|
82
|
+
|
83
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
84
|
+
<pre><code>By default, unsets the compose file for the default project. Use the
|
85
|
+
--project flag to unset the compose file of a different project.
|
86
|
+
|
87
|
+
This command can fail for the following reasons:
|
88
|
+
- A compose file is not set for the project.
|
89
|
+
|
90
|
+
For more information on the uffizzi project compose command, see:
|
91
|
+
https://docs.uffizzi.com/cli/project
|
92
|
+
|
93
|
+
For more information on the Uffizzi Compose specification, see:
|
94
|
+
https://docs.uffizzi.com/references/compose-spec
|
95
|
+
</code></pre>
|
96
|
+
|
97
|
+
<h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
|
98
|
+
<pre><code>These flags are available to all commands: --project. Run $ uffizzi
|
99
|
+
help for details.
|
100
|
+
</code></pre>
|
101
|
+
|
102
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
103
|
+
<pre><code>The following command unsets the default project’s compose file:
|
104
|
+
|
105
|
+
$ uffizzi project compose unset
|
106
|
+
</code></pre>
|
107
|
+
|
108
|
+
<ol class='man-decor man-foot man foot'>
|
109
|
+
<li class='tl'></li>
|
110
|
+
<li class='tc'>March 2022</li>
|
111
|
+
<li class='tr'>uffizzi-project-compose-unset</li>
|
112
|
+
</ol>
|
113
|
+
|
114
|
+
</div>
|
115
|
+
</body>
|
116
|
+
</html>
|
@@ -0,0 +1,27 @@
|
|
1
|
+
uffizzi-project-compose-unset - unset the compose file for a project
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi project compose unset [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
By default, unsets the compose file for the default project. Use the
|
9
|
+
--project flag to unset the compose file of a different project.
|
10
|
+
|
11
|
+
This command can fail for the following reasons:
|
12
|
+
- A compose file is not set for the project.
|
13
|
+
|
14
|
+
For more information on the uffizzi project compose command, see:
|
15
|
+
https://docs.uffizzi.com/cli/project
|
16
|
+
|
17
|
+
For more information on the Uffizzi Compose specification, see:
|
18
|
+
https://docs.uffizzi.com/references/compose-spec
|
19
|
+
|
20
|
+
## UFFIZZI WIDE FLAGS
|
21
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
22
|
+
help for details.
|
23
|
+
|
24
|
+
## EXAMPLES
|
25
|
+
The following command unsets the default project’s compose file:
|
26
|
+
|
27
|
+
$ uffizzi project compose unset
|