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.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -0
  3. data/config/uffizzi.rb +1 -0
  4. data/lib/uffizzi/cli/common.rb +2 -2
  5. data/lib/uffizzi/cli/config.rb +3 -3
  6. data/lib/uffizzi/cli/connect.rb +22 -0
  7. data/lib/uffizzi/cli/disconnect.rb +3 -0
  8. data/lib/uffizzi/cli/logout.rb +4 -0
  9. data/lib/uffizzi/cli/preview/service.rb +2 -2
  10. data/lib/uffizzi/cli/preview.rb +38 -34
  11. data/lib/uffizzi/cli/project/compose.rb +2 -2
  12. data/lib/uffizzi/cli/project/secret.rb +7 -6
  13. data/lib/uffizzi/cli.rb +28 -9
  14. data/lib/uffizzi/shell.rb +27 -2
  15. data/lib/uffizzi/version.rb +1 -1
  16. data/man/uffizzi +51 -0
  17. data/man/uffizzi-login +32 -0
  18. data/man/uffizzi-login.html +113 -0
  19. data/man/uffizzi-login.ronn +24 -0
  20. data/man/uffizzi-logout +21 -0
  21. data/man/uffizzi-logout.html +102 -0
  22. data/man/uffizzi-logout.ronn +19 -0
  23. data/man/uffizzi-preview +39 -0
  24. data/man/uffizzi-preview-create +50 -0
  25. data/man/uffizzi-preview-create.html +128 -0
  26. data/man/uffizzi-preview-create.ronn +41 -0
  27. data/man/uffizzi-preview-delete +37 -0
  28. data/man/uffizzi-preview-delete.html +115 -0
  29. data/man/uffizzi-preview-delete.ronn +28 -0
  30. data/man/uffizzi-preview-describe +38 -0
  31. data/man/uffizzi-preview-describe.html +116 -0
  32. data/man/uffizzi-preview-describe.ronn +29 -0
  33. data/man/uffizzi-preview-events +37 -0
  34. data/man/uffizzi-preview-events.html +110 -0
  35. data/man/uffizzi-preview-events.ronn +28 -0
  36. data/man/uffizzi-preview-list +33 -0
  37. data/man/uffizzi-preview-list.html +110 -0
  38. data/man/uffizzi-preview-list.ronn +25 -0
  39. data/man/uffizzi-preview-service-list +38 -0
  40. data/man/uffizzi-preview-service-list.ronn +29 -0
  41. data/man/uffizzi-preview-service-logs +57 -0
  42. data/man/uffizzi-preview-service-logs.ronn +47 -0
  43. data/man/uffizzi-preview.html +120 -0
  44. data/man/uffizzi-preview.ronn +33 -0
  45. data/man/uffizzi-preview_service_logs +57 -0
  46. data/man/uffizzi-preview_service_logs.html +142 -0
  47. data/man/uffizzi-preview_service_logs.ronn +49 -0
  48. data/man/uffizzi-project +47 -0
  49. data/man/uffizzi-project-compose +40 -0
  50. data/man/uffizzi-project-compose-describe +37 -0
  51. data/man/uffizzi-project-compose-describe.html +118 -0
  52. data/man/uffizzi-project-compose-describe.ronn +29 -0
  53. data/man/uffizzi-project-compose-set +66 -0
  54. data/man/uffizzi-project-compose-set.html +149 -0
  55. data/man/uffizzi-project-compose-set.ronn +57 -0
  56. data/man/uffizzi-project-compose-unset +35 -0
  57. data/man/uffizzi-project-compose-unset.html +116 -0
  58. data/man/uffizzi-project-compose-unset.ronn +27 -0
  59. data/man/uffizzi-project-compose.html +123 -0
  60. data/man/uffizzi-project-compose.ronn +34 -0
  61. data/man/uffizzi-project-secret +37 -0
  62. data/man/uffizzi-project-secret-create +29 -0
  63. data/man/uffizzi-project-secret-create.html +110 -0
  64. data/man/uffizzi-project-secret-create.ronn +21 -0
  65. data/man/uffizzi-project-secret-delete +29 -0
  66. data/man/uffizzi-project-secret-delete.html +110 -0
  67. data/man/uffizzi-project-secret-delete.ronn +21 -0
  68. data/man/uffizzi-project-secret-list +28 -0
  69. data/man/uffizzi-project-secret-list.html +110 -0
  70. data/man/uffizzi-project-secret-list.ronn +20 -0
  71. data/man/uffizzi-project-secret.html +119 -0
  72. data/man/uffizzi-project-secret.ronn +30 -0
  73. data/man/uffizzi-project.html +128 -0
  74. data/man/uffizzi-project.ronn +41 -0
  75. data/man/uffizzi.html +132 -0
  76. data/man/uffizzi.ronn +43 -0
  77. metadata +63 -2
@@ -0,0 +1,120 @@
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>manage 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="#COMMANDS">COMMANDS</a>
61
+ <a href="#-RUN-UFFIZZI-PREVIEW-COMMAND-HELP-FOR-MORE-INFORMATION-ON-A-COMMAND-">
62
+ Run &#39;uffizzi preview COMMAND --help&#39; for more information on a command.</a>
63
+ </div>
64
+
65
+ <ol class='man-decor man-head man head'>
66
+ <li class='tl'>preview</li>
67
+ <li class='tc'></li>
68
+ <li class='tr'>preview</li>
69
+ </ol>
70
+
71
+
72
+
73
+ <h2 id="NAME">NAME</h2>
74
+ <p class="man-name">
75
+ <code>preview</code> - <span class="man-whatis">manage previews</span>
76
+ </p>
77
+ <h2 id="SYNOPSIS">SYNOPSIS</h2>
78
+ <pre><code>uffizzi preview COMMAND [UFFIZZI_WIDE_FLAG ...]
79
+ </code></pre>
80
+
81
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
82
+ <pre><code>Manage Uffizzi previews
83
+
84
+ For more information on Uffizzi previews, see:
85
+ https://docs.uffizzi.com/cli/preview
86
+ </code></pre>
87
+
88
+ <h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
89
+ <pre><code>These flags are available to all commands: --project. Run $ uffizzi
90
+ help for details.
91
+ </code></pre>
92
+
93
+ <h2 id="COMMANDS">COMMANDS</h2>
94
+ <pre><code>COMMAND is one of the following:
95
+
96
+ create
97
+ Create a preview
98
+
99
+ delete
100
+ Delete a preview
101
+
102
+ describe
103
+ Display details of a preview
104
+
105
+ list
106
+ List all previews
107
+ </code></pre>
108
+
109
+ <h2 id="-Run-uffizzi-preview-COMMAND-help-for-more-information-on-a-command-">
110
+ Run 'uffizzi preview COMMAND --help' for more information on a command.</h2>
111
+
112
+ <ol class='man-decor man-foot man foot'>
113
+ <li class='tl'></li>
114
+ <li class='tc'>March 2022</li>
115
+ <li class='tr'>preview</li>
116
+ </ol>
117
+
118
+ </div>
119
+ </body>
120
+ </html>
@@ -0,0 +1,33 @@
1
+ uffizzi-preview - manage previews
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi preview COMMAND [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Manage Uffizzi previews
9
+
10
+ For more information on Uffizzi previews, see:
11
+ https://docs.uffizzi.com/cli/preview
12
+
13
+ ## UFFIZZI WIDE FLAGS
14
+ These flags are available to all commands: --project. Run $ uffizzi
15
+ help for details.
16
+
17
+ ## COMMANDS
18
+ COMMAND is one of the following:
19
+
20
+ create
21
+ Create a preview
22
+
23
+ delete
24
+ Delete a preview
25
+
26
+ describe
27
+ Display details of a preview
28
+
29
+ list
30
+ List all previews
31
+
32
+ ##
33
+ Run 'uffizzi preview COMMAND --help' for more information on a command.
@@ -0,0 +1,57 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-PREVIEW\-SERVICE\-LOGS" "" "April 2022" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-preview\-service\-logs\fR \- show the logs for a container service of a preview
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi preview service logs LOG_TYPE [PREVIEW_ID] [SERVICE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Shows the logs for a given container service of a given preview\.
13
+
14
+ This command can fail for the following reasons:
15
+ \- There is no preview with the given PREVIEW_ID
16
+ \- There is no service with the name SERVICE
17
+
18
+ For more information on service logs, see:
19
+ https://docs\.uffizzi\.com/cli
20
+ .fi
21
+ .SH "LOG_TYPE"
22
+ .nf
23
+ LOG_TYPE is one of the following:
24
+
25
+ build
26
+ The build logs of a service\.
27
+
28
+ container
29
+ The container logs of a service\.
30
+ .fi
31
+ .SH "POSITIONAL ARGUMENTS"
32
+ .nf
33
+ [PREVIEW_ID]
34
+ The ID of the preview that includes the service you want to
35
+ show logs for\.
36
+
37
+ [SERVICE]
38
+ The name of the service you want to show logs for\.
39
+ .fi
40
+ .SH "UFFIZZI WIDE FLAGS"
41
+ .nf
42
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
43
+ help for details\.
44
+ .fi
45
+ .SH "EXAMPLES"
46
+ .nf
47
+ The following command shows build logs for the service web\-app of the
48
+ preview with ID deployment\-14:
49
+
50
+ $ uffizzi preview service logs build deployment\-14 web\-app
51
+
52
+ The following command shows container logs for the service postgres\-db of
53
+ the preview with ID deployment\-14:
54
+
55
+ $ uffizzi preview service logs container deployment\-14 postgres\-db
56
+ .fi
57
+
@@ -0,0 +1,142 @@
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>manage 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="#NAME">NAME</a>
58
+ <a href="#SYNOPSIS">SYNOPSIS</a>
59
+ <a href="#DESCRIPTION">DESCRIPTION</a>
60
+ <a href="#LOG_TYPE">LOG_TYPE</a>
61
+ <a href="#POSITIONAL-ARGUMENTS">POSITIONAL ARGUMENTS</a>
62
+ <a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
63
+ <a href="#EXAMPLES">EXAMPLES</a>
64
+ </div>
65
+
66
+ <ol class='man-decor man-head man head'>
67
+ <li class='tl'>preview</li>
68
+ <li class='tc'></li>
69
+ <li class='tr'>preview</li>
70
+ </ol>
71
+
72
+
73
+
74
+ <h2 id="NAME">NAME</h2>
75
+ <p class="man-name">
76
+ <code>preview</code> - <span class="man-whatis">manage previews</span>
77
+ </p>
78
+ <h2 id="NAME">NAME</h2>
79
+ <pre><code>uffizzi preview service logs - show the logs for a container service
80
+ of a preview
81
+ </code></pre>
82
+
83
+ <h2 id="SYNOPSIS">SYNOPSIS</h2>
84
+ <pre><code>uffizzi preview service logs LOG_TYPE [PREVIEW_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...]
85
+ </code></pre>
86
+
87
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
88
+ <pre><code>Shows the logs for a given container service of a given preview.
89
+
90
+ This command can fail for the following reasons:
91
+ - There is no preview with the given PREVIEW_ID
92
+ - There is no service with the name SERVICE
93
+
94
+ For more information on service logs, see:
95
+ https://docs.uffizzi.com/cli
96
+ </code></pre>
97
+
98
+ <h2 id="LOG_TYPE">LOG_TYPE</h2>
99
+ <pre><code>LOG_TYPE is one of the following:
100
+
101
+ build
102
+ The build logs of a service.
103
+
104
+ container
105
+ The container logs of a service.
106
+ </code></pre>
107
+
108
+ <h2 id="POSITIONAL-ARGUMENTS">POSITIONAL ARGUMENTS</h2>
109
+ <pre><code>[PREVIEW_ID]
110
+ The ID of the preview that includes the service you want to
111
+ show logs for.
112
+
113
+ [SERVICE]
114
+ The name of the service you want to show logs for.
115
+ </code></pre>
116
+
117
+ <h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
118
+ <pre><code>These flags are available to all commands: --project. Run $ uffizzi
119
+ help for details.
120
+ </code></pre>
121
+
122
+ <h2 id="EXAMPLES">EXAMPLES</h2>
123
+ <pre><code>The following command shows build logs for the service web-app of the
124
+ preview with ID deployment-14:
125
+
126
+ $ uffizzi preview service logs build deployment-14 web-app
127
+
128
+ The following command shows container logs for the service postgres-db of
129
+ the preview with ID deployment-14:
130
+
131
+ $ uffizzi preview service logs container deployment-14 postgres-db
132
+ </code></pre>
133
+
134
+ <ol class='man-decor man-foot man foot'>
135
+ <li class='tl'></li>
136
+ <li class='tc'>March 2022</li>
137
+ <li class='tr'>preview</li>
138
+ </ol>
139
+
140
+ </div>
141
+ </body>
142
+ </html>
@@ -0,0 +1,49 @@
1
+ uffizzi-preview-service-logs - show the logs for a container service of a preview
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi preview service logs LOG_TYPE [PREVIEW_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Shows the logs for a given container service of a given preview.
9
+
10
+ This command can fail for the following reasons:
11
+ - There is no preview with the given PREVIEW_ID
12
+ - There is no service with the name SERVICE
13
+
14
+ For more information on service logs, see:
15
+ https://docs.uffizzi.com/cli
16
+
17
+ ## LOG_TYPE
18
+ LOG_TYPE is one of the following:
19
+
20
+ build
21
+ The build logs of a service.
22
+
23
+ container
24
+ The container logs of a service.
25
+
26
+ ## POSITIONAL ARGUMENTS
27
+ [PREVIEW_ID]
28
+ The ID of the preview that includes the service you want to
29
+ show logs for.
30
+
31
+ [SERVICE]
32
+ The name of the service you want to show logs for.
33
+
34
+
35
+ ## UFFIZZI WIDE FLAGS
36
+ These flags are available to all commands: --project. Run $ uffizzi
37
+ help for details.
38
+
39
+ ## EXAMPLES
40
+ The following command shows build logs for the service web-app of the
41
+ preview with ID deployment-14:
42
+
43
+ $ uffizzi preview service logs build deployment-14 web-app
44
+
45
+ The following command shows container logs for the service postgres-db of
46
+ the preview with ID deployment-14:
47
+
48
+ $ uffizzi preview service logs container deployment-14 postgres-db
49
+
@@ -0,0 +1,47 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-PROJECT" "" "April 2022" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-project\fR \- manage Uffizzi projects
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi project COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Manage Uffizzi projects
13
+
14
+ For more information on Uffizzi projects, see:
15
+ https://docs\.uffizzi\.com/cli/project
16
+ .fi
17
+ .SH "COMMANDS"
18
+ .nf
19
+ COMMAND is one of the following:
20
+
21
+ compose
22
+ Manage the compose file for a project\.
23
+
24
+ create
25
+ Create a new project\.
26
+
27
+ delete
28
+ Delete a project\.
29
+
30
+ describe
31
+ Display project meta data\.
32
+
33
+ list
34
+ List all projects in the account\.
35
+
36
+ secret
37
+ Manage secrets for a project\.
38
+
39
+ set\-as\-default
40
+ Set the default project in the uffizzi configuration\. Also see
41
+ $ uffizzi config help for details\.
42
+
43
+ update OPTIONS
44
+ Update a project\'s metadata\.
45
+ .fi
46
+ .P
47
+ Run $ uffizzi project COMMAND \-\-help for more information on a command\.
@@ -0,0 +1,40 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-PROJECT\-COMPOSE" "" "April 2022" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-project\-compose\fR \- manage the compose file for a project
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi project compose COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ By default, manages the compose file for the default project\. Use the
13
+ \-\-project flag to manage the compose file of a different 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
+ .fi
21
+ .SH "UFFIZZI WIDE FLAGS"
22
+ .nf
23
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
24
+ help for details\.
25
+ .fi
26
+ .SH "COMMANDS"
27
+ .nf
28
+ COMMAND is one of the following:
29
+
30
+ set
31
+ Set the configuration of a project with a compose file\.
32
+
33
+ describe
34
+ Display details of a compose file\.
35
+
36
+ unset
37
+ Unset the compose file for a project\.
38
+ .fi
39
+ .P
40
+ Run ‘uffizzi project compose COMMAND \-\-help’ for more information on a command\.
@@ -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