uffizzi-cli 0.7.3 → 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 (110) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -0
  3. data/config/uffizzi.rb +1 -1
  4. data/lib/uffizzi/auth_helper.rb +5 -0
  5. data/lib/uffizzi/cli/config.rb +1 -1
  6. data/lib/uffizzi/cli/connect.rb +54 -31
  7. data/lib/uffizzi/cli/disconnect.rb +1 -1
  8. data/lib/uffizzi/cli/login.rb +76 -2
  9. data/lib/uffizzi/cli/logout.rb +1 -1
  10. data/lib/uffizzi/cli/preview.rb +43 -16
  11. data/lib/uffizzi/cli/project.rb +82 -2
  12. data/lib/uffizzi/cli.rb +3 -1
  13. data/lib/uffizzi/clients/api/api_client.rb +15 -1
  14. data/lib/uffizzi/config_file.rb +14 -20
  15. data/lib/uffizzi/helpers/project_helper.rb +22 -0
  16. data/lib/uffizzi/promt.rb +21 -0
  17. data/lib/uffizzi/services/preview_service.rb +13 -25
  18. data/lib/uffizzi/services/project_service.rb +40 -0
  19. data/lib/uffizzi/version.rb +1 -1
  20. data/lib/uffizzi.rb +5 -0
  21. data/man/uffizzi +2 -2
  22. data/man/uffizzi-config +2 -2
  23. data/man/uffizzi-config.ronn +1 -1
  24. data/man/uffizzi-connect +2 -2
  25. data/man/uffizzi-connect-acr +2 -2
  26. data/man/uffizzi-connect-acr.ronn +1 -1
  27. data/man/uffizzi-connect-docker-hub +2 -2
  28. data/man/uffizzi-connect-docker-hub.ronn +1 -1
  29. data/man/uffizzi-connect-ecr +2 -2
  30. data/man/uffizzi-connect-ecr.ronn +1 -1
  31. data/man/uffizzi-connect-gcr +2 -2
  32. data/man/uffizzi-connect-gcr.ronn +1 -1
  33. data/man/uffizzi-connect-ghcr +2 -2
  34. data/man/uffizzi-connect-ghcr.ronn +1 -1
  35. data/man/uffizzi-connect.ronn +1 -1
  36. data/man/uffizzi-disconnect +2 -2
  37. data/man/uffizzi-disconnect.ronn +1 -1
  38. data/man/uffizzi-login +2 -2
  39. data/man/uffizzi-login.ronn +1 -1
  40. data/man/uffizzi-logout +2 -2
  41. data/man/uffizzi-logout.ronn +1 -1
  42. data/man/uffizzi-preview +2 -2
  43. data/man/uffizzi-preview-create +2 -2
  44. data/man/uffizzi-preview-create.ronn +1 -1
  45. data/man/uffizzi-preview-delete +2 -2
  46. data/man/uffizzi-preview-delete.ronn +1 -1
  47. data/man/uffizzi-preview-describe +2 -2
  48. data/man/uffizzi-preview-describe.ronn +1 -1
  49. data/man/uffizzi-preview-events +2 -2
  50. data/man/uffizzi-preview-events.ronn +1 -1
  51. data/man/uffizzi-preview-list +2 -2
  52. data/man/uffizzi-preview-list.ronn +1 -1
  53. data/man/uffizzi-preview-service-list +2 -2
  54. data/man/uffizzi-preview-service-list.ronn +1 -1
  55. data/man/uffizzi-preview-service-logs +2 -2
  56. data/man/uffizzi-preview-service-logs.ronn +1 -1
  57. data/man/uffizzi-preview-update +20 -12
  58. data/man/uffizzi-preview-update.ronn +6 -6
  59. data/man/uffizzi-preview.ronn +1 -1
  60. data/man/uffizzi-preview_service_logs +2 -2
  61. data/man/uffizzi-preview_service_logs.ronn +1 -1
  62. data/man/uffizzi-project +2 -2
  63. data/man/uffizzi-project-compose +2 -2
  64. data/man/uffizzi-project-compose-describe +2 -2
  65. data/man/uffizzi-project-compose-describe.ronn +1 -1
  66. data/man/uffizzi-project-compose-set +2 -2
  67. data/man/uffizzi-project-compose-set.ronn +1 -1
  68. data/man/uffizzi-project-compose-unset +2 -2
  69. data/man/uffizzi-project-compose-unset.ronn +1 -1
  70. data/man/uffizzi-project-compose.ronn +1 -1
  71. data/man/uffizzi-project-create +50 -0
  72. data/man/uffizzi-project-create.ronn +41 -0
  73. data/man/uffizzi-project-delete +32 -0
  74. data/man/uffizzi-project-delete.ronn +24 -0
  75. data/man/uffizzi-project-describe +43 -0
  76. data/man/uffizzi-project-describe.ronn +34 -0
  77. data/man/uffizzi-project-secret +2 -2
  78. data/man/uffizzi-project-secret-create +2 -2
  79. data/man/uffizzi-project-secret-create.ronn +1 -1
  80. data/man/uffizzi-project-secret-delete +2 -2
  81. data/man/uffizzi-project-secret-delete.ronn +1 -1
  82. data/man/uffizzi-project-secret-list +2 -2
  83. data/man/uffizzi-project-secret-list.ronn +1 -1
  84. data/man/uffizzi-project-secret.ronn +1 -1
  85. data/man/uffizzi-project-set-default +2 -2
  86. data/man/uffizzi-project-set-default.ronn +1 -1
  87. data/man/uffizzi-project.ronn +1 -1
  88. data/man/uffizzi.html +1 -1
  89. data/man/uffizzi.ronn +1 -1
  90. metadata +25 -22
  91. data/man/uffizzi-config.html +0 -144
  92. data/man/uffizzi-login.html +0 -113
  93. data/man/uffizzi-logout.html +0 -102
  94. data/man/uffizzi-preview-create.html +0 -128
  95. data/man/uffizzi-preview-delete.html +0 -115
  96. data/man/uffizzi-preview-describe.html +0 -116
  97. data/man/uffizzi-preview-events.html +0 -110
  98. data/man/uffizzi-preview-list.html +0 -110
  99. data/man/uffizzi-preview.html +0 -120
  100. data/man/uffizzi-preview_service_logs.html +0 -142
  101. data/man/uffizzi-project-compose-describe.html +0 -118
  102. data/man/uffizzi-project-compose-set.html +0 -149
  103. data/man/uffizzi-project-compose-unset.html +0 -116
  104. data/man/uffizzi-project-compose.html +0 -123
  105. data/man/uffizzi-project-secret-create.html +0 -110
  106. data/man/uffizzi-project-secret-delete.html +0 -110
  107. data/man/uffizzi-project-secret-list.html +0 -110
  108. data/man/uffizzi-project-secret.html +0 -119
  109. data/man/uffizzi-project-set-default.html +0 -111
  110. data/man/uffizzi-project.html +0 -128
@@ -12,7 +12,7 @@ uffizzi-preview-delete - delete a preview
12
12
  - The preview specified belongs to a different project.
13
13
 
14
14
  For more information on Uffizzi previews, see:
15
- https://docs.uffizzi.com/cli/preview
15
+ https://github.com/UffizziCloud/uffizzi_cli
16
16
 
17
17
  ## POSITIONAL ARGUMENTS
18
18
  [PREVIEW_ID]
@@ -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\-PREVIEW\-DESCRIBE" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PREVIEW\-DESCRIBE" "" "May 2022" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-preview\-describe\fR \- show metadata for a preview
6
6
  .SH "SYNOPSIS"
@@ -16,7 +16,7 @@ This command can fail for the following reasons:
16
16
  \- The preview specified belongs to a different project\.
17
17
 
18
18
  For more information on Uffizzi previews, see:
19
- https://docs\.uffizzi\.com/cli/preview
19
+ https://github\.com/UffizziCloud/uffizzi_cli
20
20
  .fi
21
21
  .SH "POSITIONAL ARGUMENTS"
22
22
  .nf
@@ -12,7 +12,7 @@ uffizzi-preview-describe - show metadata for a preview
12
12
  - The preview specified belongs to a different project.
13
13
 
14
14
  For more information on Uffizzi previews, see:
15
- https://docs.uffizzi.com/cli/preview
15
+ https://github.com/UffizziCloud/uffizzi_cli
16
16
 
17
17
  ## POSITIONAL ARGUMENTS
18
18
  [PREVIEW_ID]
@@ -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\-PREVIEW\-EVENTS" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PREVIEW\-EVENTS" "" "May 2022" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-preview\-events\fR \- show the deployment event logs for a preview
6
6
  .SH "SYNOPSIS"
@@ -15,7 +15,7 @@ This command can fail for the following reasons:
15
15
  \- There is no preview with the given PREVIEW_ID
16
16
 
17
17
  For more information on event logs, see:
18
- https://docs\.uffizzi\.com/cli
18
+ https://github\.com/UffizziCloud/uffizzi_cli
19
19
  .fi
20
20
  .SH "POSITIONAL ARGUMENTS"
21
21
  .nf
@@ -11,7 +11,7 @@ uffizzi-preview-events - show the deployment event logs for a preview
11
11
  - There is no preview with the given PREVIEW_ID
12
12
 
13
13
  For more information on event logs, see:
14
- https://docs.uffizzi.com/cli
14
+ https://github.com/UffizziCloud/uffizzi_cli
15
15
 
16
16
  ## POSITIONAL ARGUMENTS
17
17
  [PREVIEW_ID]
@@ -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\-PREVIEW\-LIST" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PREVIEW\-LIST" "" "May 2022" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-preview\-list\fR \- list previews in a project
6
6
  .SH "SYNOPSIS"
@@ -13,7 +13,7 @@ Lists all previews for a project, including active, building,
13
13
  deploying and failed previews\.
14
14
 
15
15
  For more information on Uffizzi previews, see:
16
- https://docs\.uffizzi\.com/cli/preview
16
+ https://github\.com/UffizziCloud/uffizzi_cli
17
17
  .fi
18
18
  .SH "UFFIZZI WIDE FLAGS"
19
19
  .nf
@@ -9,7 +9,7 @@ uffizzi-preview-list - list previews in a project
9
9
  deploying and failed previews.
10
10
 
11
11
  For more information on Uffizzi previews, see:
12
- https://docs.uffizzi.com/cli/preview
12
+ https://github.com/UffizziCloud/uffizzi_cli
13
13
 
14
14
  ## UFFIZZI WIDE FLAGS
15
15
  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\-PREVIEW\-SERVICE\-LIST" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PREVIEW\-SERVICE\-LIST" "" "May 2022" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-preview\-service\-list\fR \- list the container services of a given preview
6
6
  .SH "SYNOPSIS"
@@ -16,7 +16,7 @@ This command can fail for the following reasons:
16
16
  \- There is no preview with the given PREVIEW_ID
17
17
 
18
18
  For more information on preview services, see:
19
- https://docs\.uffizzi\.com/cli
19
+ https://github\.com/UffizziCloud/uffizzi_cli
20
20
  .fi
21
21
  .SH "POSITIONAL ARGUMENTS"
22
22
  .nf
@@ -12,7 +12,7 @@
12
12
  - There is no preview with the given PREVIEW_ID
13
13
 
14
14
  For more information on preview services, see:
15
- https://docs.uffizzi.com/cli
15
+ https://github.com/UffizziCloud/uffizzi_cli
16
16
 
17
17
  ## POSITIONAL ARGUMENTS
18
18
  [PREVIEW_ID]
@@ -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\-PREVIEW\-SERVICE\-LOGS" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PREVIEW\-SERVICE\-LOGS" "" "May 2022" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-preview\-service\-logs\fR \- show the logs for a container service of a preview
6
6
  .SH "SYNOPSIS"
@@ -16,7 +16,7 @@ This command can fail for the following reasons:
16
16
  \- There is no service with the name SERVICE
17
17
 
18
18
  For more information on service logs, see:
19
- https://docs\.uffizzi\.com/cli
19
+ https://github\.com/UffizziCloud/uffizzi_cli
20
20
  .fi
21
21
  .SH "LOG_TYPE"
22
22
  .nf
@@ -12,7 +12,7 @@
12
12
  - There is no service with the name SERVICE
13
13
 
14
14
  For more information on service logs, see:
15
- https://docs.uffizzi.com/cli
15
+ https://github.com/UffizziCloud/uffizzi_cli
16
16
 
17
17
  ## LOG_TYPE
18
18
  LOG_TYPE is one of the following:
@@ -1,34 +1,42 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UPDATE" "" "April 2022" ""
3
+ .TH "UPDATE" "" "May 2022" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi preview update\fR \- update a preview
6
6
  .SH "SYNOPSIS"
7
- \fBuffizzi preview update [PREVIEW_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
7
+ .nf
8
+ uffizzi preview update [PREVIEW_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
8
10
  .SH "DESCRIPTION"
9
- \fBGiven a preview ID and new compose file, update a preview\. Updating a preview does not change its preview URL\.
11
+ .nf
12
+ Given a preview ID and new compose file, update a preview\. Updating a
13
+ preview does not change its preview URL\.
10
14
 
11
15
  This command can fail for the following reasons:
12
16
  \- There is no preview with the given PREVIEW_ID
13
17
  \- The COMPOSE_FILE specified is invalid
14
18
 
15
19
  For more information on Uffizzi previews, see:
16
- https://docs\.uffizzi\.com/cli/preview
20
+ https://github\.com/UffizziCloud/uffizzi_cli
21
+ .fi
17
22
  .SH "POSITIONAL ARGUMENTS"
18
- \fB[PREVIEW_ID]
19
23
  .nf
24
+ [PREVIEW_ID]
20
25
  The ID of the preview that you want to update\.
21
- .P
22
- \fB[COMPOSE_FILE]
23
- .nf
26
+
27
+ [COMPOSE_FILE]
24
28
  The new compose file you want to preview\.
29
+ .fi
25
30
  .SH "UFFIZZI WIDE FLAGS"
26
- These flags are available to all commands: \-\-project\. Run $ uffizzi help for details\.
31
+ .nf
32
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
33
+ help for details\.
34
+ .fi
27
35
  .SH "EXAMPLES"
28
- The following command updates a preview with ID deployment\-67 using compose file docker\-compose\.alt\.yml:
29
- .P
30
36
  .nf
37
+ The following command updates a preview with ID deployment\-67 using
38
+ compose file docker\-compose\.alt\.yml:
39
+
31
40
  $ uffizzi preview update deployment\-67 docker\-compose\.alt\.yml
32
41
  .fi
33
- .IP "" 0
34
42
 
@@ -1,10 +1,10 @@
1
1
  uffizzi preview update - update a preview
2
2
  ================================================================
3
3
 
4
- SYNOPSIS
4
+ ## SYNOPSIS
5
5
  uffizzi preview update [PREVIEW_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
6
6
 
7
- DESCRIPTION
7
+ ## DESCRIPTION
8
8
  Given a preview ID and new compose file, update a preview. Updating a
9
9
  preview does not change its preview URL.
10
10
 
@@ -13,20 +13,20 @@ DESCRIPTION
13
13
  - The COMPOSE_FILE specified is invalid
14
14
 
15
15
  For more information on Uffizzi previews, see:
16
- https://docs.uffizzi.com/cli/preview
16
+ https://github.com/UffizziCloud/uffizzi_cli
17
17
 
18
- POSITIONAL ARGUMENTS
18
+ ## POSITIONAL ARGUMENTS
19
19
  [PREVIEW_ID]
20
20
  The ID of the preview that you want to update.
21
21
 
22
22
  [COMPOSE_FILE]
23
23
  The new compose file you want to preview.
24
24
 
25
- UFFIZZI WIDE FLAGS
25
+ ## UFFIZZI WIDE FLAGS
26
26
  These flags are available to all commands: --project. Run $ uffizzi
27
27
  help for details.
28
28
 
29
- EXAMPLES
29
+ ## EXAMPLES
30
30
  The following command updates a preview with ID deployment-67 using
31
31
  compose file docker-compose.alt.yml:
32
32
 
@@ -8,7 +8,7 @@ uffizzi-preview - manage previews
8
8
  Manage Uffizzi previews
9
9
 
10
10
  For more information on Uffizzi previews, see:
11
- https://docs.uffizzi.com/cli/preview
11
+ https://github.com/UffizziCloud/uffizzi_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\-PREVIEW\-SERVICE\-LOGS" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PREVIEW\-SERVICE\-LOGS" "" "May 2022" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-preview\-service\-logs\fR \- show the logs for a container service of a preview
6
6
  .SH "SYNOPSIS"
@@ -16,7 +16,7 @@ This command can fail for the following reasons:
16
16
  \- There is no service with the name SERVICE
17
17
 
18
18
  For more information on service logs, see:
19
- https://docs\.uffizzi\.com/cli
19
+ https://github\.com/UffizziCloud/uffizzi_cli
20
20
  .fi
21
21
  .SH "LOG_TYPE"
22
22
  .nf
@@ -12,7 +12,7 @@
12
12
  - There is no service with the name SERVICE
13
13
 
14
14
  For more information on service logs, see:
15
- https://docs.uffizzi.com/cli
15
+ https://github.com/UffizziCloud/uffizzi_cli
16
16
 
17
17
  ## LOG_TYPE
18
18
  LOG_TYPE is one of the following:
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" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PROJECT" "" "May 2022" ""
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://docs\.uffizzi\.com/cli/project
15
+ https://github\.com/UffizziCloud/uffizzi_cli
16
16
  .fi
17
17
  .SH "COMMANDS"
18
18
  .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\-COMPOSE" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-COMPOSE" "" "May 2022" ""
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://docs\.uffizzi\.com/cli/project
16
+ https://github\.com/UffizziCloud/uffizzi_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" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-COMPOSE\-DESCRIBE" "" "May 2022" ""
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://docs\.uffizzi\.com/cli/project
20
+ https://github\.com/UffizziCloud/uffizzi_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://docs.uffizzi.com/cli/project
16
+ https://github.com/UffizziCloud/uffizzi_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" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-COMPOSE\-SET" "" "May 2022" ""
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://docs\.uffizzi\.com/cli/project
29
+ https://github\.com/UffizziCloud/uffizzi_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://docs.uffizzi.com/cli/project
25
+ https://github.com/UffizziCloud/uffizzi_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" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-COMPOSE\-UNSET" "" "May 2022" ""
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://docs\.uffizzi\.com/cli/project
19
+ https://github\.com/UffizziCloud/uffizzi_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://docs.uffizzi.com/cli/project
15
+ https://github.com/UffizziCloud/uffizzi_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://docs.uffizzi.com/cli/project
12
+ https://github.com/UffizziCloud/uffizzi_cli
13
13
 
14
14
  For more information on the Uffizzi Compose specification, see:
15
15
  https://docs.uffizzi.com/references/compose-spec
@@ -0,0 +1,50 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-PROJECT\-CREATE" "" "May 2022" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-project\-create\fR \- create a new project
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi project create [\-\-name=NAME] [\-\-slug=SLUG]
9
+ [\-\-description=DESCRIPTION] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
10
+ .fi
11
+ .SH "DESCRIPTION"
12
+ .nf
13
+ Create new project\.
14
+
15
+ This command can fail for the following reasons:
16
+ \- The project \-\-description is too long\.
17
+ \- The project \-\-name flag is not specified\.
18
+ \- The project \-\-slug is malformed or used by another project\.
19
+
20
+ For more information on the uffizzi project command, see:
21
+ https:/github\.com/UffizziCloud/uffizzi_cli
22
+ .fi
23
+ .SH "FLAGS"
24
+ .nf
25
+ \-\-description=DESCRIPTION
26
+ Description for the project you want to create\. Max of 256
27
+ characters\.
28
+
29
+ \-\-name=NAME
30
+ Name for the project you want to create\.
31
+
32
+ \-\-slug=SLUG
33
+ A URL\-compatible name\. Do not include whitespaces or special characters\.
34
+ Project slugs must be globally unique across all Uffizzi projects\.
35
+ If a slug is not provided, Uffizzi will automatically generate one\.
36
+ .fi
37
+ .SH "UFFIZZI WIDE FLAGS"
38
+ .nf
39
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
40
+ help for details\.
41
+ .fi
42
+ .SH "EXAMPLES"
43
+ .nf
44
+ To create a new project with name My App, project slug my\-app, and
45
+ description "My first project", run:
46
+
47
+ $ uffizzi project create \-\-name="My App" \-\-slug="my\-app" \e
48
+ \-\-description="My first project"
49
+ .fi
50
+
@@ -0,0 +1,41 @@
1
+ uffizzi-project-create - create a new project
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi project create [--name=NAME] [--slug=SLUG]
6
+ [--description=DESCRIPTION] [UFFIZZI_WIDE_FLAG ...]
7
+
8
+ ## DESCRIPTION
9
+ Create new project.
10
+
11
+ This command can fail for the following reasons:
12
+ - The project --description is too long.
13
+ - The project --name flag is not specified.
14
+ - The project --slug is malformed or used by another project.
15
+
16
+ For more information on the uffizzi project command, see:
17
+ https:/github.com/UffizziCloud/uffizzi_cli
18
+
19
+ ## FLAGS
20
+ --description=DESCRIPTION
21
+ Description for the project you want to create. Max of 256
22
+ characters.
23
+
24
+ --name=NAME
25
+ Name for the project you want to create.
26
+
27
+ --slug=SLUG
28
+ A URL-compatible name. Do not include whitespaces or special characters.
29
+ Project slugs must be globally unique across all Uffizzi projects.
30
+ If a slug is not provided, Uffizzi will automatically generate one.
31
+
32
+ ## UFFIZZI WIDE FLAGS
33
+ These flags are available to all commands: --project. Run $ uffizzi
34
+ help for details.
35
+
36
+ ## EXAMPLES
37
+ To create a new project with name My App, project slug my-app, and
38
+ description "My first project", run:
39
+
40
+ $ uffizzi project create --name="My App" --slug="my-app" \
41
+ --description="My first project"
@@ -0,0 +1,32 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-PROJECT\-DELETE" "" "May 2022" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-project\-delete\fR \- delete a project
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi project delete PROJECT_SLUG [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Deletes a project with the given project slug\.
13
+
14
+ This command can fail for the following reasons:
15
+ \- There is no project with the given project slug
16
+ \- The active account does not have permission to delete the project
17
+
18
+ For more information on Uffizzi projects, see:
19
+ https:/github\.com/UffizziCloud/uffizzi_cli
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 "EXAMPLES"
27
+ .nf
28
+ To delete a project with project slug my\-app\-xc8fw, run:
29
+
30
+ $ uffizzi project delete my\-app\-xc8fw
31
+ .fi
32
+
@@ -0,0 +1,24 @@
1
+ uffizzi-project-delete - delete a project
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi project delete PROJECT_SLUG [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Deletes a project with the given project slug.
9
+
10
+ This command can fail for the following reasons:
11
+ - There is no project with the given project slug
12
+ - The active account does not have permission to delete the project
13
+
14
+ For more information on Uffizzi projects, see:
15
+ https:/github.com/UffizziCloud/uffizzi_cli
16
+
17
+ ## UFFIZZI WIDE FLAGS
18
+ These flags are available to all commands: --project. Run $ uffizzi
19
+ help for details.
20
+
21
+ ## EXAMPLES
22
+ To delete a project with project slug my-app-xc8fw, run:
23
+
24
+ $ uffizzi project delete my-app-xc8fw
@@ -0,0 +1,43 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "DESCRIBE" "" "May 2022" ""
4
+ .SH "NAME"
5
+ \fBuffizzi project describe\fR \- show metadata for a project
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi project describe PROJECT_SLUG [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Shows metadata for a project given a valid project slug\.
13
+
14
+ This command can fail for the following reasons:
15
+ \- There is no project with the given project slug
16
+
17
+ For more information on Uffizzi projects, see:
18
+ https://github\.com/UffizziCloud/uffizzi_cli
19
+ .fi
20
+ .SH "UFFIZZI WIDE FLAGS"
21
+ .nf
22
+ \-\-output FORMAT
23
+ Output format\. FORMAT is one of the following: json, pretty
24
+ Default is json\.
25
+ .fi
26
+ .SH "UFFIZZI WIDE FLAGS"
27
+ .nf
28
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
29
+ help for details\.
30
+ .fi
31
+ .SH "EXAMPLES"
32
+ .nf
33
+ The following command prints metadata in json format for a project with the
34
+ project slug my\-app\-xc8fw:
35
+
36
+ $ uffizzi project describe my\-app\-xc8fw
37
+
38
+ The following command pretty prints metadata for a project with the project
39
+ slug my\-app\-xc8fw:
40
+
41
+ $ uffizzi project describe my\-app\-xc8fw \-\-output pretty
42
+ .fi
43
+
@@ -0,0 +1,34 @@
1
+ uffizzi project describe - show metadata for a project
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi project describe PROJECT_SLUG [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Shows metadata for a project given a valid project slug.
9
+
10
+ This command can fail for the following reasons:
11
+ - There is no project with the given project slug
12
+
13
+ For more information on Uffizzi projects, see:
14
+ https://github.com/UffizziCloud/uffizzi_cli
15
+
16
+ ## UFFIZZI WIDE FLAGS
17
+ --output FORMAT
18
+ Output format. FORMAT is one of the following: json, pretty
19
+ Default is json.
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 metadata in json format for a project with the
27
+ project slug my-app-xc8fw:
28
+
29
+ $ uffizzi project describe my-app-xc8fw
30
+
31
+ The following command pretty prints metadata for a project with the project
32
+ slug my-app-xc8fw:
33
+
34
+ $ uffizzi project describe my-app-xc8fw --output pretty
@@ -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" "" "April 2022" ""
3
+ .TH "UFFIZZI\-PROJECT\-SECRET" "" "May 2022" ""
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://docs\.uffizzi\.com/cli/secret
16
+ https://github\.com/UffizziCloud/uffizzi_cli
17
17
  .fi
18
18
  .SH "UFFIZZI WIDE FLAGS"
19
19
  .nf