uffizzi-cli 1.0.4 → 2.0.29

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 (156) hide show
  1. checksums.yaml +4 -4
  2. data/config/uffizzi.rb +1 -0
  3. data/lib/uffizzi/auth_helper.rb +13 -5
  4. data/lib/uffizzi/cli/account.rb +122 -0
  5. data/lib/uffizzi/cli/cluster.rb +363 -0
  6. data/lib/uffizzi/cli/common.rb +2 -4
  7. data/lib/uffizzi/cli/config.rb +5 -4
  8. data/lib/uffizzi/cli/connect.rb +14 -8
  9. data/lib/uffizzi/cli/disconnect.rb +1 -1
  10. data/lib/uffizzi/cli/login.rb +130 -66
  11. data/lib/uffizzi/cli/login_by_identity_token.rb +11 -7
  12. data/lib/uffizzi/cli/preview/service.rb +3 -4
  13. data/lib/uffizzi/cli/preview.rb +33 -32
  14. data/lib/uffizzi/cli/project.rb +17 -9
  15. data/lib/uffizzi/cli.rb +46 -7
  16. data/lib/uffizzi/clients/api/api_client.rb +92 -2
  17. data/lib/uffizzi/clients/api/api_routes.rb +44 -0
  18. data/lib/uffizzi/clients/api/http_client.rb +19 -7
  19. data/lib/uffizzi/config_file.rb +15 -40
  20. data/lib/uffizzi/error.rb +15 -0
  21. data/lib/uffizzi/helpers/config_helper.rb +49 -0
  22. data/lib/uffizzi/helpers/file_helper.rb +25 -0
  23. data/lib/uffizzi/helpers/login_helper.rb +33 -0
  24. data/lib/uffizzi/helpers/project_helper.rb +19 -0
  25. data/lib/uffizzi/promt.rb +4 -0
  26. data/lib/uffizzi/response_helper.rb +33 -14
  27. data/lib/uffizzi/services/cluster_service.rb +59 -0
  28. data/lib/uffizzi/services/compose_file_service.rb +5 -4
  29. data/lib/uffizzi/services/env_variables_service.rb +4 -2
  30. data/lib/uffizzi/services/github_service.rb +21 -0
  31. data/lib/uffizzi/services/kubeconfig_service.rb +132 -0
  32. data/lib/uffizzi/services/preview_service.rb +52 -18
  33. data/lib/uffizzi/shell.rb +19 -16
  34. data/lib/uffizzi/token.rb +37 -0
  35. data/lib/uffizzi/version.rb +1 -1
  36. data/lib/uffizzi.rb +10 -0
  37. data/man/uffizzi +7 -5
  38. data/man/uffizzi-account +29 -0
  39. data/man/uffizzi-account-list +26 -0
  40. data/man/uffizzi-account-list.html +103 -0
  41. data/man/uffizzi-account-list.ronn +19 -0
  42. data/man/uffizzi-account-set-default +29 -0
  43. data/man/uffizzi-account-set-default.html +105 -0
  44. data/man/uffizzi-account-set-default.ronn +22 -0
  45. data/man/uffizzi-account.html +106 -0
  46. data/man/uffizzi-account.ronn +23 -0
  47. data/man/uffizzi-cluster +37 -0
  48. data/man/uffizzi-cluster-create +49 -0
  49. data/man/uffizzi-cluster-create.ronn +41 -0
  50. data/man/uffizzi-cluster-delete +32 -0
  51. data/man/uffizzi-cluster-delete.ronn +24 -0
  52. data/man/uffizzi-cluster-describe +39 -0
  53. data/man/uffizzi-cluster-describe.ronn +30 -0
  54. data/man/uffizzi-cluster-list +34 -0
  55. data/man/uffizzi-cluster-list.ronn +26 -0
  56. data/man/uffizzi-cluster-update-kubeconfig +37 -0
  57. data/man/uffizzi-cluster-update-kubeconfig.ronn +29 -0
  58. data/man/uffizzi-cluster.ronn +32 -0
  59. data/man/uffizzi-compose +39 -0
  60. data/man/uffizzi-compose-create +67 -0
  61. data/man/uffizzi-compose-create.ronn +57 -0
  62. data/man/uffizzi-compose-delete +38 -0
  63. data/man/uffizzi-compose-delete.ronn +29 -0
  64. data/man/uffizzi-compose-describe +38 -0
  65. data/man/uffizzi-compose-describe.ronn +29 -0
  66. data/man/uffizzi-compose-events +38 -0
  67. data/man/uffizzi-compose-events.ronn +29 -0
  68. data/man/uffizzi-compose-list +58 -0
  69. data/man/uffizzi-compose-list.ronn +49 -0
  70. data/man/uffizzi-compose-service-list +42 -0
  71. data/man/uffizzi-compose-service-list.ronn +32 -0
  72. data/man/uffizzi-compose-service-logs +59 -0
  73. data/man/uffizzi-compose-service-logs.ronn +48 -0
  74. data/man/uffizzi-compose-update +61 -0
  75. data/man/uffizzi-compose-update.ronn +51 -0
  76. data/man/uffizzi-compose.ronn +33 -0
  77. data/man/uffizzi-compose_service_logs +59 -0
  78. data/man/uffizzi-compose_service_logs.ronn +50 -0
  79. data/man/uffizzi-config +2 -2
  80. data/man/uffizzi-config.ronn +1 -1
  81. data/man/uffizzi-connect +2 -4
  82. data/man/uffizzi-connect-acr +2 -2
  83. data/man/uffizzi-connect-acr.ronn +1 -1
  84. data/man/uffizzi-connect-docker-hub +2 -2
  85. data/man/uffizzi-connect-docker-hub.ronn +1 -1
  86. data/man/uffizzi-connect-docker-registry +2 -2
  87. data/man/uffizzi-connect-docker-registry.ronn +1 -1
  88. data/man/uffizzi-connect-ecr +2 -2
  89. data/man/uffizzi-connect-ecr.ronn +1 -1
  90. data/man/uffizzi-connect-gcr +2 -2
  91. data/man/uffizzi-connect-gcr.ronn +1 -1
  92. data/man/uffizzi-connect-ghcr +2 -2
  93. data/man/uffizzi-connect-ghcr.ronn +1 -1
  94. data/man/uffizzi-connect.ronn +2 -2
  95. data/man/uffizzi-disconnect +2 -2
  96. data/man/uffizzi-disconnect.ronn +1 -1
  97. data/man/uffizzi-login +7 -3
  98. data/man/uffizzi-login-by-identity-token +3 -3
  99. data/man/uffizzi-login-by-identity-token.ronn +2 -2
  100. data/man/uffizzi-login.html +113 -0
  101. data/man/uffizzi-login.ronn +6 -2
  102. data/man/uffizzi-logout +2 -2
  103. data/man/uffizzi-logout.ronn +1 -1
  104. data/man/uffizzi-preview +9 -9
  105. data/man/uffizzi-preview-create +22 -20
  106. data/man/uffizzi-preview-create.ronn +28 -26
  107. data/man/uffizzi-preview-delete +11 -10
  108. data/man/uffizzi-preview-delete.ronn +12 -11
  109. data/man/uffizzi-preview-describe +10 -10
  110. data/man/uffizzi-preview-describe.ronn +11 -11
  111. data/man/uffizzi-preview-events +12 -11
  112. data/man/uffizzi-preview-events.ronn +13 -12
  113. data/man/uffizzi-preview-list +19 -18
  114. data/man/uffizzi-preview-list.ronn +21 -20
  115. data/man/uffizzi-preview-service-list +16 -12
  116. data/man/uffizzi-preview-service-list.ronn +16 -13
  117. data/man/uffizzi-preview-service-logs +14 -12
  118. data/man/uffizzi-preview-service-logs.ronn +18 -17
  119. data/man/uffizzi-preview-update +19 -18
  120. data/man/uffizzi-preview-update.ronn +21 -20
  121. data/man/uffizzi-preview.ronn +10 -10
  122. data/man/uffizzi-preview_service_logs +14 -12
  123. data/man/uffizzi-preview_service_logs.ronn +18 -17
  124. data/man/uffizzi-project +3 -3
  125. data/man/uffizzi-project-compose +2 -2
  126. data/man/uffizzi-project-compose-describe +2 -2
  127. data/man/uffizzi-project-compose-describe.ronn +1 -1
  128. data/man/uffizzi-project-compose-set +2 -2
  129. data/man/uffizzi-project-compose-set.ronn +1 -1
  130. data/man/uffizzi-project-compose-unset +2 -2
  131. data/man/uffizzi-project-compose-unset.ronn +1 -1
  132. data/man/uffizzi-project-compose.ronn +1 -1
  133. data/man/uffizzi-project-create +2 -2
  134. data/man/uffizzi-project-create.ronn +1 -1
  135. data/man/uffizzi-project-delete +2 -2
  136. data/man/uffizzi-project-delete.ronn +1 -1
  137. data/man/uffizzi-project-describe +3 -3
  138. data/man/uffizzi-project-describe.ronn +1 -1
  139. data/man/uffizzi-project-preview-describe +37 -0
  140. data/man/uffizzi-project-preview-describe.ronn +29 -0
  141. data/man/uffizzi-project-preview-set +66 -0
  142. data/man/uffizzi-project-preview-set.ronn +57 -0
  143. data/man/uffizzi-project-secret +2 -2
  144. data/man/uffizzi-project-secret-create +2 -2
  145. data/man/uffizzi-project-secret-create.ronn +1 -1
  146. data/man/uffizzi-project-secret-delete +2 -2
  147. data/man/uffizzi-project-secret-delete.ronn +1 -1
  148. data/man/uffizzi-project-secret-list +2 -2
  149. data/man/uffizzi-project-secret-list.ronn +1 -1
  150. data/man/uffizzi-project-secret.ronn +1 -1
  151. data/man/uffizzi-project-set-default +2 -2
  152. data/man/uffizzi-project-set-default.ronn +1 -1
  153. data/man/uffizzi-project.html +124 -0
  154. data/man/uffizzi-project.ronn +2 -2
  155. data/man/uffizzi.ronn +12 -10
  156. metadata +131 -19
@@ -1,22 +1,24 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PREVIEW\-SERVICE\-LOGS" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PREVIEW_SERVICE_LOGS" "" "August 2023" ""
4
4
  .SH "NAME"
5
- \fBuffizzi\-preview\-service\-logs\fR \- show the logs for a container service of a preview
5
+ \fBuffizzi\-preview_service_logs\fR
6
+ .P
7
+ uffizzi\-compose\-service\-logs \- show the logs for a container service of a compose environment (preview) ================================================================
6
8
  .SH "SYNOPSIS"
7
9
  .nf
8
- uffizzi preview service logs LOG_TYPE [PREVIEW_ID] [SERVICE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
10
+ uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
11
  .fi
10
12
  .SH "DESCRIPTION"
11
13
  .nf
12
- Shows the logs for a given container service of a given preview\.
14
+ Shows the logs for a given container service of a given compose environment (preview)\.
13
15
 
14
16
  This command can fail for the following reasons:
15
- \- There is no preview with the given PREVIEW_ID
17
+ \- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
16
18
  \- There is no service with the name SERVICE
17
19
 
18
20
  For more information on service logs, see:
19
- https://github\.com/UffizziCloud/uffizzi_cli
21
+ https://docs\.uffizzi\.com/references/cli/
20
22
  .fi
21
23
  .SH "LOG_TYPE"
22
24
  .nf
@@ -30,8 +32,8 @@ container
30
32
  .fi
31
33
  .SH "POSITIONAL ARGUMENTS"
32
34
  .nf
33
- [PREVIEW_ID]
34
- The ID of the preview that includes the service you want to
35
+ [COMPOSE_ENVIRONMENT_ID]
36
+ The ID of the compose environment (preview) that includes the service you want to
35
37
  show logs for\.
36
38
 
37
39
  [SERVICE]
@@ -45,13 +47,13 @@ help for details\.
45
47
  .SH "EXAMPLES"
46
48
  .nf
47
49
  The following command shows build logs for the service web\-app of the
48
- preview with ID deployment\-14:
50
+ compose environment (preview) with ID deployment\-14:
49
51
 
50
- $ uffizzi preview service logs build deployment\-14 web\-app
52
+ $ uffizzi compose service logs build deployment\-14 web\-app
51
53
 
52
54
  The following command shows container logs for the service postgres\-db of
53
- the preview with ID deployment\-14:
55
+ the compose environment (preview) with ID deployment\-14:
54
56
 
55
- $ uffizzi preview service logs container deployment\-14 postgres\-db
57
+ $ uffizzi compose service logs container deployment\-14 postgres\-db
56
58
  .fi
57
59
 
@@ -1,31 +1,32 @@
1
- uffizzi-preview-service-logs - show the logs for a container service of a preview
1
+ uffizzi-compose-service-logs - show the logs for a container service
2
+ of a compose environment (preview)
2
3
  ================================================================
3
4
 
4
5
  ## SYNOPSIS
5
- uffizzi preview service logs LOG_TYPE [PREVIEW_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...]
6
+ uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...]
6
7
 
7
8
  ## DESCRIPTION
8
- Shows the logs for a given container service of a given preview.
9
+ Shows the logs for a given container service of a given compose environment (preview).
9
10
 
10
- This command can fail for the following reasons:
11
- - There is no preview with the given PREVIEW_ID
11
+ This command can fail for the following reasons:
12
+ - There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
12
13
  - There is no service with the name SERVICE
13
14
 
14
15
  For more information on service logs, see:
15
- https://github.com/UffizziCloud/uffizzi_cli
16
+ https://docs.uffizzi.com/references/cli/
16
17
 
17
18
  ## LOG_TYPE
18
19
  LOG_TYPE is one of the following:
19
-
20
+
20
21
  build
21
22
  The build logs of a service.
22
-
23
+
23
24
  container
24
25
  The container logs of a service.
25
26
 
26
27
  ## POSITIONAL ARGUMENTS
27
- [PREVIEW_ID]
28
- The ID of the preview that includes the service you want to
28
+ [COMPOSE_ENVIRONMENT_ID]
29
+ The ID of the compose environment (preview) that includes the service you want to
29
30
  show logs for.
30
31
 
31
32
  [SERVICE]
@@ -33,17 +34,17 @@
33
34
 
34
35
 
35
36
  ## UFFIZZI WIDE FLAGS
36
- These flags are available to all commands: --project. Run $ uffizzi
37
+ These flags are available to all commands: --project. Run $ uffizzi
37
38
  help for details.
38
39
 
39
40
  ## EXAMPLES
40
- The following command shows build logs for the service web-app of the
41
- preview with ID deployment-14:
41
+ The following command shows build logs for the service web-app of the
42
+ compose environment (preview) with ID deployment-14:
42
43
 
43
- $ uffizzi preview service logs build deployment-14 web-app
44
+ $ uffizzi compose service logs build deployment-14 web-app
44
45
 
45
- The following command shows container logs for the service postgres-db of
46
- the preview with ID deployment-14:
46
+ The following command shows container logs for the service postgres-db of
47
+ the compose environment (preview) with ID deployment-14:
47
48
 
48
- $ uffizzi preview service logs container deployment-14 postgres-db
49
+ $ uffizzi compose service logs container deployment-14 postgres-db
49
50
 
data/man/uffizzi-project CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\fR \- manage Uffizzi projects
6
6
  .SH "SYNOPSIS"
@@ -12,7 +12,7 @@ uffizzi project COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
12
12
  Manage Uffizzi projects
13
13
 
14
14
  For more information on Uffizzi projects, see:
15
- https://github\.com/UffizziCloud/uffizzi_cli
15
+ https://docs\.uffizzi\.com/references/cli/
16
16
  .fi
17
17
  .SH "COMMANDS"
18
18
  .nf
@@ -36,7 +36,7 @@ COMMAND is one of the following:
36
36
  secret
37
37
  Manage secrets for a project\.
38
38
 
39
- set\-as\-default
39
+ set\-default
40
40
  Set the default project in the uffizzi configuration\. Also see
41
41
  $ uffizzi config help for details\.
42
42
 
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT\-COMPOSE" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-COMPOSE" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\-compose\fR \- manage the compose file for a project
6
6
  .SH "SYNOPSIS"
@@ -13,7 +13,7 @@ By default, manages the compose file for the default project\. Use the
13
13
  \-\-project flag to manage the compose file of a different project\.
14
14
 
15
15
  For more information on the uffizzi project compose command, see:
16
- https://github\.com/UffizziCloud/uffizzi_cli
16
+ https://docs\.uffizzi\.com/references/cli/
17
17
 
18
18
  For more information on the Uffizzi Compose specification, see:
19
19
  https://docs\.uffizzi\.com/references/compose\-spec
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT\-COMPOSE\-DESCRIBE" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-COMPOSE\-DESCRIBE" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\-compose\-describe\fR \- show metadata for a compose file
6
6
  .SH "SYNOPSIS"
@@ -17,7 +17,7 @@ This command can fail for the following reasons:
17
17
  \- A compose file is not set for the project\.
18
18
 
19
19
  For more information on the uffizzi project compose command, see:
20
- https://github\.com/UffizziCloud/uffizzi_cli
20
+ https://docs\.uffizzi\.com/references/cli/
21
21
 
22
22
  For more information on the Uffizzi Compose specification, see:
23
23
  https://docs\.uffizzi\.com/references/compose\-spec
@@ -13,7 +13,7 @@
13
13
  - A compose file is not set for the project.
14
14
 
15
15
  For more information on the uffizzi project compose command, see:
16
- https://github.com/UffizziCloud/uffizzi_cli
16
+ https://docs.uffizzi.com/references/cli/
17
17
 
18
18
  For more information on the Uffizzi Compose specification, see:
19
19
  https://docs.uffizzi.com/references/compose-spec
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT\-COMPOSE\-SET" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-COMPOSE\-SET" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\-compose\-set\fR \- sets the configuration of a project with a compose file
6
6
  .SH "SYNOPSIS"
@@ -26,7 +26,7 @@ This command can fail for the following reasons:
26
26
  \- The compose file is invalid\.
27
27
 
28
28
  For more information on the uffizzi project compose command, see:
29
- https://github\.com/UffizziCloud/uffizzi_cli
29
+ https://docs\.uffizzi\.com/references/cli/
30
30
 
31
31
  For more information on the Uffizzi Compose specification, see:
32
32
  https://docs\.uffizzi\.com/references/compose\-spec
@@ -22,7 +22,7 @@
22
22
  - The compose file is invalid.
23
23
 
24
24
  For more information on the uffizzi project compose command, see:
25
- https://github.com/UffizziCloud/uffizzi_cli
25
+ https://docs.uffizzi.com/references/cli/
26
26
 
27
27
  For more information on the Uffizzi Compose specification, see:
28
28
  https://docs.uffizzi.com/references/compose-spec
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT\-COMPOSE\-UNSET" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-COMPOSE\-UNSET" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\-compose\-unset\fR \- unset the compose file for a project
6
6
  .SH "SYNOPSIS"
@@ -16,7 +16,7 @@ This command can fail for the following reasons:
16
16
  \- A compose file is not set for the project\.
17
17
 
18
18
  For more information on the uffizzi project compose command, see:
19
- https://github\.com/UffizziCloud/uffizzi_cli
19
+ https://docs\.uffizzi\.com/references/cli/
20
20
 
21
21
  For more information on the Uffizzi Compose specification, see:
22
22
  https://docs\.uffizzi\.com/references/compose\-spec
@@ -12,7 +12,7 @@
12
12
  - A compose file is not set for the project.
13
13
 
14
14
  For more information on the uffizzi project compose command, see:
15
- https://github.com/UffizziCloud/uffizzi_cli
15
+ https://docs.uffizzi.com/references/cli/
16
16
 
17
17
  For more information on the Uffizzi Compose specification, see:
18
18
  https://docs.uffizzi.com/references/compose-spec
@@ -9,7 +9,7 @@
9
9
  --project flag to manage the compose file of a different project.
10
10
 
11
11
  For more information on the uffizzi project compose command, see:
12
- https://github.com/UffizziCloud/uffizzi_cli
12
+ https://docs.uffizzi.com/references/cli/
13
13
 
14
14
  For more information on the Uffizzi Compose specification, see:
15
15
  https://docs.uffizzi.com/references/compose-spec
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT\-CREATE" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-CREATE" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\-create\fR \- create a new project
6
6
  .SH "SYNOPSIS"
@@ -18,7 +18,7 @@ This command can fail for the following reasons:
18
18
  \- The project \-\-slug is malformed or used by another project\.
19
19
 
20
20
  For more information on the uffizzi project command, see:
21
- https:/github\.com/UffizziCloud/uffizzi_cli
21
+ https:/docs\.uffizzi\.com/references/cli/
22
22
  .fi
23
23
  .SH "FLAGS"
24
24
  .nf
@@ -14,7 +14,7 @@ uffizzi-project-create - create a new project
14
14
  - The project --slug is malformed or used by another project.
15
15
 
16
16
  For more information on the uffizzi project command, see:
17
- https:/github.com/UffizziCloud/uffizzi_cli
17
+ https:/docs.uffizzi.com/references/cli/
18
18
 
19
19
  ## FLAGS
20
20
  --description=DESCRIPTION
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT\-DELETE" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-DELETE" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\-delete\fR \- delete a project
6
6
  .SH "SYNOPSIS"
@@ -16,7 +16,7 @@ This command can fail for the following reasons:
16
16
  \- The active account does not have permission to delete the project
17
17
 
18
18
  For more information on Uffizzi projects, see:
19
- https:/github\.com/UffizziCloud/uffizzi_cli
19
+ https:/docs\.uffizzi\.com/references/cli/
20
20
  .fi
21
21
  .SH "UFFIZZI WIDE FLAGS"
22
22
  .nf
@@ -12,7 +12,7 @@ uffizzi-project-delete - delete a project
12
12
  - The active account does not have permission to delete the project
13
13
 
14
14
  For more information on Uffizzi projects, see:
15
- https:/github.com/UffizziCloud/uffizzi_cli
15
+ https:/docs.uffizzi.com/references/cli/
16
16
 
17
17
  ## UFFIZZI WIDE FLAGS
18
18
  These flags are available to all commands: --project. Run $ uffizzi
@@ -1,8 +1,8 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "DESCRIBE" "" "May 2022" ""
3
+ .TH "DESCRIBE" "" "August 2023" ""
4
4
  .SH "NAME"
5
- \fBuffizzi project describe\fR \- show metadata for a project
5
+ \fBdescribe\fR \- show metadata for a project
6
6
  .SH "SYNOPSIS"
7
7
  .nf
8
8
  uffizzi project describe PROJECT_SLUG [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
@@ -15,7 +15,7 @@ This command can fail for the following reasons:
15
15
  \- There is no project with the given project slug
16
16
 
17
17
  For more information on Uffizzi projects, see:
18
- https://github\.com/UffizziCloud/uffizzi_cli
18
+ https://docs\.uffizzi\.com/references/cli/
19
19
  .fi
20
20
  .SH "UFFIZZI WIDE FLAGS"
21
21
  .nf
@@ -11,7 +11,7 @@
11
11
  - There is no project with the given project slug
12
12
 
13
13
  For more information on Uffizzi projects, see:
14
- https://github.com/UffizziCloud/uffizzi_cli
14
+ https://docs.uffizzi.com/references/cli/
15
15
 
16
16
  ## UFFIZZI WIDE FLAGS
17
17
  --output FORMAT
@@ -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" "" "August 2023" ""
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/references/cli/
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,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/references/cli/
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" "" "August 2023" ""
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/references/cli/
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,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/references/cli/
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"
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT\-SECRET" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-SECRET" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\-secret\fR \- manage secrets for a project
6
6
  .SH "SYNOPSIS"
@@ -13,7 +13,7 @@ Manage secrets for a project\. Once added, project secrets cannot
13
13
  be viewed or edited\.
14
14
 
15
15
  For more information on secrets, see:
16
- https://github\.com/UffizziCloud/uffizzi_cli
16
+ https://docs\.uffizzi\.com/references/cli/
17
17
  .fi
18
18
  .SH "UFFIZZI WIDE FLAGS"
19
19
  .nf
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT\-SECRET\-CREATE" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-SECRET\-CREATE" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\-secret\-create\fR \- Creates a secret from STDIN
6
6
  .SH "SYNOPSIS"
@@ -12,7 +12,7 @@ uffizzi project secret create SECRET [\-] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
12
12
  Creates a secret from STDIN
13
13
 
14
14
  For more information on the uffizzi project secret command, see:
15
- https://github\.com/UffizziCloud/uffizzi_cli
15
+ https://docs\.uffizzi\.com/references/cli/
16
16
  .fi
17
17
  .SH "UFFIZZI WIDE FLAGS"
18
18
  .nf
@@ -8,7 +8,7 @@
8
8
  Creates a secret from STDIN
9
9
 
10
10
  For more information on the uffizzi project secret command, see:
11
- https://github.com/UffizziCloud/uffizzi_cli
11
+ https://docs.uffizzi.com/references/cli/
12
12
 
13
13
  ## UFFIZZI WIDE FLAGS
14
14
  These flags are available to all commands: --project. Run $ uffizzi
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT\-SECRET\-DELETE" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-SECRET\-DELETE" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\-secret\-delete\fR \- deletes a secret
6
6
  .SH "SYNOPSIS"
@@ -12,7 +12,7 @@ uffizzi project secret delete [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
12
12
  Deletes a secret
13
13
 
14
14
  For more information on the uffizzi project secret command, see:
15
- https://github\.com/UffizziCloud/uffizzi_cli
15
+ https://docs\.uffizzi\.com/references/cli/
16
16
  .fi
17
17
  .SH "UFFIZZI WIDE FLAGS"
18
18
  .nf
@@ -8,7 +8,7 @@
8
8
  Deletes a secret
9
9
 
10
10
  For more information on the uffizzi project secret command, see:
11
- https://github.com/UffizziCloud/uffizzi_cli
11
+ https://docs.uffizzi.com/references/cli/
12
12
 
13
13
  ## UFFIZZI WIDE FLAGS
14
14
  These flags are available to all commands: --project. Run $ uffizzi
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PROJECT\-SECRET\-LIST" "" "May 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-SECRET\-LIST" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-project\-secret\-list\fR \- lists metadata for all secrets in a project
6
6
  .SH "SYNOPSIS"
@@ -12,7 +12,7 @@ uffizzi project secret list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
12
12
  Lists metadata for all secrets in a project
13
13
 
14
14
  For more information on the uffizzi project secret command, see:
15
- https://github\.com/UffizziCloud/uffizzi_cli
15
+ https://docs\.uffizzi\.com/references/cli/
16
16
  .fi
17
17
  .SH "UFFIZZI WIDE FLAGS"
18
18
  .nf
@@ -8,7 +8,7 @@
8
8
  Lists metadata for all secrets in a project
9
9
 
10
10
  For more information on the uffizzi project secret command, see:
11
- https://github.com/UffizziCloud/uffizzi_cli
11
+ https://docs.uffizzi.com/references/cli/
12
12
 
13
13
  ## UFFIZZI WIDE FLAGS
14
14
  These flags are available to all commands: --project. Run $ uffizzi