uffizzi-cli 0.9.0 → 0.10.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 (95) hide show
  1. checksums.yaml +4 -4
  2. data/lib/uffizzi/auth_helper.rb +5 -0
  3. data/lib/uffizzi/cli/config.rb +1 -1
  4. data/lib/uffizzi/cli/login.rb +76 -2
  5. data/lib/uffizzi/cli/logout.rb +1 -1
  6. data/lib/uffizzi/cli/preview.rb +4 -1
  7. data/lib/uffizzi/clients/api/api_client.rb +1 -1
  8. data/lib/uffizzi/config_file.rb +8 -18
  9. data/lib/uffizzi/promt.rb +21 -0
  10. data/lib/uffizzi/version.rb +1 -1
  11. data/lib/uffizzi.rb +5 -0
  12. data/man/uffizzi +2 -2
  13. data/man/uffizzi-config +1 -1
  14. data/man/uffizzi-config.ronn +1 -1
  15. data/man/uffizzi-connect +2 -2
  16. data/man/uffizzi-connect-acr +2 -2
  17. data/man/uffizzi-connect-acr.ronn +1 -1
  18. data/man/uffizzi-connect-docker-hub +2 -2
  19. data/man/uffizzi-connect-docker-hub.ronn +1 -1
  20. data/man/uffizzi-connect-ecr +2 -2
  21. data/man/uffizzi-connect-ecr.ronn +1 -1
  22. data/man/uffizzi-connect-gcr +2 -2
  23. data/man/uffizzi-connect-gcr.ronn +1 -1
  24. data/man/uffizzi-connect-ghcr +2 -2
  25. data/man/uffizzi-connect-ghcr.ronn +1 -1
  26. data/man/uffizzi-connect.ronn +1 -1
  27. data/man/uffizzi-disconnect +2 -2
  28. data/man/uffizzi-disconnect.ronn +1 -1
  29. data/man/uffizzi-login +1 -1
  30. data/man/uffizzi-login.ronn +1 -1
  31. data/man/uffizzi-logout +1 -1
  32. data/man/uffizzi-logout.ronn +1 -1
  33. data/man/uffizzi-preview +2 -2
  34. data/man/uffizzi-preview-create +2 -2
  35. data/man/uffizzi-preview-create.ronn +1 -1
  36. data/man/uffizzi-preview-delete +2 -2
  37. data/man/uffizzi-preview-delete.ronn +1 -1
  38. data/man/uffizzi-preview-describe +2 -2
  39. data/man/uffizzi-preview-describe.ronn +1 -1
  40. data/man/uffizzi-preview-events +2 -2
  41. data/man/uffizzi-preview-events.ronn +1 -1
  42. data/man/uffizzi-preview-list +2 -2
  43. data/man/uffizzi-preview-list.ronn +1 -1
  44. data/man/uffizzi-preview-service-list +2 -2
  45. data/man/uffizzi-preview-service-list.ronn +1 -1
  46. data/man/uffizzi-preview-service-logs +2 -2
  47. data/man/uffizzi-preview-service-logs.ronn +1 -1
  48. data/man/uffizzi-preview-update +20 -12
  49. data/man/uffizzi-preview-update.ronn +6 -6
  50. data/man/uffizzi-preview.ronn +1 -1
  51. data/man/uffizzi-preview_service_logs +2 -2
  52. data/man/uffizzi-preview_service_logs.ronn +1 -1
  53. data/man/uffizzi-project +2 -2
  54. data/man/uffizzi-project-compose +2 -2
  55. data/man/uffizzi-project-compose-describe +2 -2
  56. data/man/uffizzi-project-compose-describe.ronn +1 -1
  57. data/man/uffizzi-project-compose-set +2 -2
  58. data/man/uffizzi-project-compose-set.ronn +1 -1
  59. data/man/uffizzi-project-compose-unset +2 -2
  60. data/man/uffizzi-project-compose-unset.ronn +1 -1
  61. data/man/uffizzi-project-compose.ronn +1 -1
  62. data/man/uffizzi-project-secret +2 -2
  63. data/man/uffizzi-project-secret-create +2 -2
  64. data/man/uffizzi-project-secret-create.ronn +1 -1
  65. data/man/uffizzi-project-secret-delete +2 -2
  66. data/man/uffizzi-project-secret-delete.ronn +1 -1
  67. data/man/uffizzi-project-secret-list +2 -2
  68. data/man/uffizzi-project-secret-list.ronn +1 -1
  69. data/man/uffizzi-project-secret.ronn +1 -1
  70. data/man/uffizzi-project-set-default +2 -2
  71. data/man/uffizzi-project-set-default.ronn +1 -1
  72. data/man/uffizzi-project.ronn +1 -1
  73. data/man/uffizzi.html +1 -1
  74. data/man/uffizzi.ronn +1 -1
  75. metadata +17 -22
  76. data/man/uffizzi-config.html +0 -144
  77. data/man/uffizzi-login.html +0 -113
  78. data/man/uffizzi-logout.html +0 -102
  79. data/man/uffizzi-preview-create.html +0 -128
  80. data/man/uffizzi-preview-delete.html +0 -115
  81. data/man/uffizzi-preview-describe.html +0 -116
  82. data/man/uffizzi-preview-events.html +0 -110
  83. data/man/uffizzi-preview-list.html +0 -110
  84. data/man/uffizzi-preview.html +0 -120
  85. data/man/uffizzi-preview_service_logs.html +0 -142
  86. data/man/uffizzi-project-compose-describe.html +0 -118
  87. data/man/uffizzi-project-compose-set.html +0 -149
  88. data/man/uffizzi-project-compose-unset.html +0 -116
  89. data/man/uffizzi-project-compose.html +0 -123
  90. data/man/uffizzi-project-secret-create.html +0 -110
  91. data/man/uffizzi-project-secret-delete.html +0 -110
  92. data/man/uffizzi-project-secret-list.html +0 -110
  93. data/man/uffizzi-project-secret.html +0 -119
  94. data/man/uffizzi-project-set-default.html +0 -111
  95. data/man/uffizzi-project.html +0 -128
@@ -1,142 +0,0 @@
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>
@@ -1,118 +0,0 @@
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>
@@ -1,149 +0,0 @@
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>
@@ -1,116 +0,0 @@
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>
@@ -1,123 +0,0 @@
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</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="#COMMANDS">COMMANDS</a>
62
- </div>
63
-
64
- <ol class='man-decor man-head man head'>
65
- <li class='tl'>uffizzi-project-compose</li>
66
- <li class='tc'></li>
67
- <li class='tr'>uffizzi-project-compose</li>
68
- </ol>
69
-
70
-
71
- <h2 id="NAME">NAME</h2>
72
- <p class="man-name">
73
- <code>uffizzi-project-compose</code>
74
- </p>
75
- <h2 id="NAME">NAME</h2>
76
- <pre><code>uffizzi project compose - manage the compose file for a project
77
- </code></pre>
78
-
79
- <h2 id="SYNOPSIS">SYNOPSIS</h2>
80
- <pre><code>uffizzi project compose COMMAND [UFFIZZI_WIDE_FLAG ...]
81
- </code></pre>
82
-
83
- <h2 id="DESCRIPTION">DESCRIPTION</h2>
84
- <pre><code>By default, manages the compose file for the default project. Use the
85
- --project flag to manage the compose file of a different project.
86
-
87
- For more information on the uffizzi project compose command, see:
88
- https://docs.uffizzi.com/cli/project
89
-
90
- For more information on the Uffizzi Compose specification, see:
91
- https://docs.uffizzi.com/references/compose-spec
92
- </code></pre>
93
-
94
- <h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
95
- <pre><code>These flags are available to all commands: --project. Run $ uffizzi
96
- help for details.
97
- </code></pre>
98
-
99
- <h2 id="COMMANDS">COMMANDS</h2>
100
- <pre><code>COMMAND is one of the following:
101
-
102
- set
103
- Set the configuration of a project with a compose file.
104
-
105
- describe
106
- Display details of a compose file.
107
-
108
- unset
109
- Unset the compose file for a project.
110
- </code></pre>
111
-
112
- <p>Run ‘uffizzi project compose COMMAND --help’ for more information on a
113
- command.</p>
114
-
115
- <ol class='man-decor man-foot man foot'>
116
- <li class='tl'></li>
117
- <li class='tc'>March 2022</li>
118
- <li class='tr'>uffizzi-project-compose</li>
119
- </ol>
120
-
121
- </div>
122
- </body>
123
- </html>