uffizzi-cli 0.11.5 → 1.0.0

data/man/uffizzi-connect-ecr

@@ -1,35 +1,37 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT\-ECR" "" "May 2022" ""
+.TH "UFFIZZI\-CONNECT\-ECR" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\-ecr\fR \- grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
 .SH "SYNOPSIS"
-.nf
-uffizzi connect ecr
-.fi
+\fBuffizzi connect ecr\fR [\-\-registry=REGISTRY] [\-\-id=ID] [\-\-secret=SECRET]
 .SH "DESCRIPTION"
-.nf
-Given valid credentials, grants a Uffizzi user account access
-to a private Amazon Elastic Container Registry
-
-This command can fail for the following reasons:
-    \- The active user does not have permission to connect
-      external services\.
-    \- The given credentials are invalid\.
-
+Given valid credentials, grants a Uffizzi user account access to a private Amazon Elastic Container Registry
+.P
+Credentials can be provided interactively or non\-interactively via command options or environment variables:
+.br
+\fBAWS_REGISTRY_URL\fR, \fBAWS_ACCESS_KEY_ID\fR, \fBAWS_SECRET_ACCESS_KEY\fR
+.P
+This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
+.P
 For more information on connecting to external services, see:
+.br
 https://github\.com/UffizziCloud/uffizzi_cli
-
-For detailed instructions on configuring webhooks to send push
-notifications to Uffizzi, see
+.P
+For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
+.br
 https://docs\.uffizzi\.com/guides/container\-registry\-integrations
-.fi
+.SH "OPTIONS"
+.TP
+\fB\-r\fR, \fB\-\-registry=<registry>\fR
+URL of the service\.
+.TP
+\fB\-\-id=<id>\fR
+Access key id for the service\.
+.TP
+\fB\-s\fR, \fB\-\-secret=<secret>\fR
+Secret access key for the service\.
 .SH "EXAMPLES"
-.nf
-The following command will prompt the user to enter ACR
-credentials, including registry domain, access key ID and
-secret access key:
-
-    $ uffizzi connect ecr
-.fi
-
+The following command will prompt the user to enter ACR credentials, including registry domain, access key ID and secret access key:
+.P
+\fBuffizzi connect ecr\fR

data/man/uffizzi-connect-ecr.ronn

@@ -1,28 +1,42 @@
-uffizzi-connect-ecr - grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
-================================================================
+# uffizzi-connect-ecr - grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
 
 ## SYNOPSIS
-    uffizzi connect ecr
+
+`uffizzi connect ecr` [--registry=REGISTRY] [--id=ID] [--secret=SECRET]
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access 
-    to a private Amazon Elastic Container Registry
 
-    This command can fail for the following reasons:
-        - The active user does not have permission to connect 
-          external services.
-        - The given credentials are invalid.
+Given valid credentials, grants a Uffizzi user account access 
+to a private Amazon Elastic Container Registry
+
+Credentials can be provided interactively or non-interactively
+via command options or environment variables:  
+`AWS_REGISTRY_URL`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`
+
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
+
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
 
-    For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see 
-    https://docs.uffizzi.com/guides/container-registry-integrations
+## OPTIONS
+
+* `-r`, `--registry=<registry>`:
+  URL of the service.
+* `--id=<id>`:
+  Access key id for the service.
+* `-s`, `--secret=<secret>`:
+  Secret access key for the service.
 
 ## EXAMPLES
-    The following command will prompt the user to enter ACR 
-    credentials, including registry domain, access key ID and 
-    secret access key:
-          
-        $ uffizzi connect ecr
+
+The following command will prompt the user to enter ACR 
+credentials, including registry domain, access key ID and 
+secret access key:
+
+`uffizzi connect ecr`

data/man/uffizzi-connect-gcr

@@ -1,40 +1,31 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT\-GCR" "" "May 2022" ""
+.TH "UFFIZZI\-CONNECT\-GCR" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\-gcr\fR \- grant a Uffizzi user account access to a private Google Container Registry (GCR)
 .SH "SYNOPSIS"
-.nf
-uffizzi connect gcr [KEY_FILE]
-.fi
+\fBuffizzi connect gcr\fR [KEY_FILE]
 .SH "DESCRIPTION"
-.nf
-Given valid credentials, grants a Uffizzi user account access
-to a private Google Container Registry
-
-This command can fail for the following reasons:
-    \- The active user does not have permission to connect
-      external services\.
-    \- The given credentials are invalid\.
-
+Given valid credentials, grants a Uffizzi user account access to a private Google Container Registry
+.P
+Credentials can be provided via a key file or environment variable:
+.br
+\fBGCLOUD_SERVICE_KEY\fR
+.P
+This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
+.P
 For more information on connecting to external services, see:
+.br
 https://github\.com/UffizziCloud/uffizzi_cli
-
-For detailed instructions on configuring webhooks to send push
-notifications to Uffizzi, see
+.P
+For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
+.br
 https://docs\.uffizzi\.com/guides/container\-registry\-integrations
-.fi
-.SH "POSITIONAL ARGUMENTS"
-.nf
+.SH "ARGUMENTS"
+.TP
 KEY_FILE
-    A Google Cloud service account key file\. The key file is a
-    JSON file that grants Uffizzi access to a private GCR\.
-.fi
+A Google Cloud service account key file\. The key file is a JSON file that grants Uffizzi access to a private GCR\.
 .SH "EXAMPLES"
-.nf
-The following command uses a Google Cloud service account key
-file called sa\-private\-key\.json to connect to a private GCR:
-
-    $ uffizzi connect gcr sa\-private\-key\.json
-.fi
-
+The following command uses a Google Cloud service account key file called sa\-private\-key\.json to connect to a private GCR:
+.P
+\fBuffizzi connect gcr sa\-private\-key\.json\fR

data/man/uffizzi-connect-gcr.ronn

@@ -1,32 +1,36 @@
-uffizzi-connect-gcr - grant a Uffizzi user account access to a private Google Container Registry (GCR)
-================================================================
+# uffizzi-connect-gcr - grant a Uffizzi user account access to a private Google Container Registry (GCR)
 
 ## SYNOPSIS
-    uffizzi connect gcr [KEY_FILE]
+
+`uffizzi connect gcr` [KEY_FILE]
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access 
-    to a private Google Container Registry
 
-    This command can fail for the following reasons:
-        - The active user does not have permission to connect 
-          external services.
-        - The given credentials are invalid.
+Given valid credentials, grants a Uffizzi user account access 
+to a private Google Container Registry
+
+Credentials can be provided via a key file or environment variable:  
+`GCLOUD_SERVICE_KEY`
+
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
-    For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see 
-    https://docs.uffizzi.com/guides/container-registry-integrations
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
 
-## POSITIONAL ARGUMENTS
-    KEY_FILE
-        A Google Cloud service account key file. The key file is a 
-        JSON file that grants Uffizzi access to a private GCR.
+## ARGUMENTS
+
+* KEY_FILE:
+  A Google Cloud service account key file. The key file is a JSON file that grants Uffizzi access to a private GCR.
 
 ## EXAMPLES
-    The following command uses a Google Cloud service account key 
-    file called sa-private-key.json to connect to a private GCR:
-          
-        $ uffizzi connect gcr sa-private-key.json
+
+The following command uses a Google Cloud service account key 
+file called sa-private-key.json to connect to a private GCR:
+
+`uffizzi connect gcr sa-private-key.json`

data/man/uffizzi-connect-ghcr

@@ -1,44 +1,34 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT\-GHCR" "" "July 2022" ""
+.TH "UFFIZZI\-CONNECT\-GHCR" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\-ghcr\fR \- grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
 .SH "SYNOPSIS"
-.nf
-uffizzi connect ghcr [OPTION]\|\.\|\.\|\.
-.fi
+\fBuffizzi connect ghcr\fR [\-\-username=USERNAME] [\-\-token=TOKEN]
 .SH "DESCRIPTION"
-.nf
-Given valid credentials, grants a Uffizzi user account access
-to a private GitHub Container Registry\.
-
-Credentials can be provided interactively or non\-interactively
-via command options or environment variables:
-GITHUB_USERNAME, GITHUB_ACCESS_TOKEN
-
-This command can fail for the following reasons:
-    \- The active user does not have permission to connect
-      external services\.
-    \- The given credentials are invalid\.
-
+Given valid credentials, grants a Uffizzi user account access to a private GitHub Container Registry\.
+.P
+Credentials can be provided interactively or non\-interactively via command options or environment variables:
+.br
+\fBGITHUB_USERNAME\fR, \fBGITHUB_ACCESS_TOKEN\fR
+.P
+This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
+.P
 For more information on connecting to external services, see:
+.br
 https://github\.com/UffizziCloud/uffizzi_cli
-
-For detailed instructions on configuring webhooks to send push
-notifications to Uffizzi, see
+.P
+For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
+.br
 https://docs\.uffizzi\.com/guides/container\-registry\-integrations
-.fi
 .SH "OPTIONS"
-.nf
-\-u, \-\-username        GitHub username
-\-t, \-\-token           Personal access token from GitHub
-.fi
+.TP
+\fB\-u\fR, \fB\-\-username=<username>\fR
+Username for the service\.
+.TP
+\fB\-t\fR, \fB\-\-token=<token>\fR
+Access token for the service\.
 .SH "EXAMPLES"
-.nf
-The following command will prompt the user to enter GHCR
-credentials, including GitHub account name and
-personal access token (PAT):
-
-uffizzi connect ghcr
-.fi
-
+The following command will prompt the user to enter GHCR credentials, including GitHub account name and personal access token (PAT):
+.P
+\fBuffizzi connect ghcr\fR

data/man/uffizzi-connect-ghcr.ronn

@@ -1,36 +1,40 @@
-uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
-================================================================
+# uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
 
 ## SYNOPSIS
-    uffizzi connect ghcr [OPTION]...
+
+`uffizzi connect ghcr` [--username=USERNAME] [--token=TOKEN]
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access
-    to a private GitHub Container Registry.
 
-    Credentials can be provided interactively or non-interactively
-    via command options or environment variables:
-    GITHUB_USERNAME, GITHUB_ACCESS_TOKEN
+Given valid credentials, grants a Uffizzi user account access
+to a private GitHub Container Registry.
+
+Credentials can be provided interactively or non-interactively
+via command options or environment variables:  
+`GITHUB_USERNAME`, `GITHUB_ACCESS_TOKEN`
 
-    This command can fail for the following reasons:
-        - The active user does not have permission to connect
-          external services.
-        - The given credentials are invalid.
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
-    For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see
-    https://docs.uffizzi.com/guides/container-registry-integrations
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
 
 ## OPTIONS
-    -u, --username        GitHub username
-    -t, --token           Personal access token from GitHub
+
+* `-u`, `--username=<username>`:
+  Username for the service.
+* `-t`, `--token=<token>`:
+  Access token for the service.
 
 ## EXAMPLES
-    The following command will prompt the user to enter GHCR
-    credentials, including GitHub account name and
-    personal access token (PAT):
 
-    uffizzi connect ghcr
+The following command will prompt the user to enter GHCR
+credentials, including GitHub account name and
+personal access token (PAT):
+
+`uffizzi connect ghcr`

data/man/uffizzi-connect.ronn

@@ -1,37 +1,45 @@
-uffizzi-connect - grant a Uffizzi user account access to external services
-================================================================
+# uffizzi-connect - grant a Uffizzi user account access to external services
 
 ## SYNOPSIS
-    uffizzi connect COMMAND
+
+`uffizzi connect` COMMAND [--skip-raise-existence-error] [--update-credential-if-exists]
 
 ## DESCRIPTION
-    Grants a Uffizzi user account access to external services
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+Grants a Uffizzi user account access to external services.
+
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
 ## COMMANDS
-    COMMAND is one of the following:
 
-    acr
-        Connect to Azure Container Registry (azurecr.io).
+COMMAND is one of the following:
+
+* `acr`:
+  Connect to Azure Container Registry (azurecr.io).
 
-    docker-hub
-        Connect to Docker Hub (hub.docker.com).
+* `docker-hub`:
+  Connect to Docker Hub (hub.docker.com).
 
-    ecr
-        Connect to Amazon Elastic Container Registry (amazonaws.com).
+* `docker-registry`:
+  Connect to any registry implementing the Docker Registry HTTP API protocol
 
-    gcr
-        Connect to Google Container Registry (gcr.io).
+* `ecr`:
+  Connect to Amazon Elastic Container Registry (amazonaws.com).
 
-    ghcr
-        Connect to GitHub Container Registry (ghcr.io).
+* `gcr`:
+  Connect to Google Container Registry (gcr.io).
+
+* `ghcr`:
+  Connect to GitHub Container Registry (ghcr.io).
 
 
 ## FLAGS
-    --skip-raise-existence-error        If credential exist, do not raise an exception, just print a message
 
-    --update-credential-if-exists       Update credential if it exists
+* `--skip-raise-existence-error`:
+  If credential exists, do not raise an exception, just print a message.
+
+* `--update-credential-if-exists`:
+  Update credential if it exists.
 
-Run 'uffizzi connect COMMAND --help' for more information on a command.
+Run `uffizzi connect COMMAND --help` for more information on a command.

data/man/uffizzi-login-by-identity-token

@@ -0,0 +1,29 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-LOGIN\-BY\-IDENTITY\-TOKEN" "" "August 2022" ""
+.SH "NAME"
+\fBuffizzi\-login\-by\-identity\-token\fR \- login to Uffizzi using a OIDC token provided by a CI/CD pipeline
+.SH "SYNOPSIS"
+.nf
+uffizzi uffizzi\-login\-by\-identity\-token [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline\.
+If a user/account do not exist, Uffizzi will create them based on token payload\.
+
+For more information on authentication and credential types, see:
+https://github\.com/UffizziCloud/uffizzi_cli
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+To login from the CI/CD pipeline, run:
+
+    $ uffizzi uffizzi\-login\-by\-identity\-token \-\-server=uffizzi\.example\.com \-\-token=[$CI_JOB_TOKEN]
+.fi
+

data/man/uffizzi-login-by-identity-token.html

@@ -0,0 +1,106 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' content='text/html;charset=utf8'>
+  <meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
+  <title>login to Uffizzi using a OIDC token provided by a CI/CD pipeline</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .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}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .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}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  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}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>uffizzi-login-by-identity-token</li>
+    <li class='tc'></li>
+    <li class='tr'>uffizzi-login-by-identity-token</li>
+  </ol>
+
+  
+
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>uffizzi-login-by-identity-token</code> - <span class="man-whatis">login to Uffizzi using a OIDC token provided by a CI/CD pipeline</span>
+</p>
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+<pre><code>uffizzi uffizzi-login-by-identity-token [UFFIZZI_WIDE_FLAG ...]
+</code></pre>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+<pre><code>The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline.
+If a user/account do not exist, Uffizzi will create them based on token payload.
+
+For more information on authentication and credential types, see:
+https://github.com/UffizziCloud/uffizzi_cli
+</code></pre>
+
+<h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
+<pre><code>These flags are available to all commands: --project. Run $ uffizzi 
+help for details.
+</code></pre>
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+<pre><code>To login from the CI/CD pipeline, run:
+
+    $ uffizzi uffizzi-login-by-identity-token --server=uffizzi.example.com --token=[$CI_JOB_TOKEN]
+</code></pre>
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>August 2022</li>
+    <li class='tr'>uffizzi-login-by-identity-token</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/uffizzi-login-by-identity-token.ronn

@@ -0,0 +1,21 @@
+  uffizzi-login-by-identity-token - login to Uffizzi using a OIDC token provided by a CI/CD pipeline
+================================================================
+
+## SYNOPSIS
+    uffizzi uffizzi-login-by-identity-token [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline.
+    If a user/account do not exist, Uffizzi will create them based on token payload.
+
+    For more information on authentication and credential types, see:
+    https://github.com/UffizziCloud/uffizzi_cli
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    To login from the CI/CD pipeline, run:
+
+        $ uffizzi uffizzi-login-by-identity-token --server=uffizzi.example.com --token=[$CI_JOB_TOKEN]

data/man/uffizzi-preview-create

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-PREVIEW\-CREATE" "" "May 2022" ""
+.TH "UFFIZZI\-PREVIEW\-CREATE" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-preview\-create\fR \- create a preview
 .SH "SYNOPSIS"
@@ -32,6 +32,12 @@ https://github\.com/UffizziCloud/uffizzi_cli
     the previews they create: when the preview is deleted, the
     alternate compose is deleted by the Uffizzi API\.
 .fi
+.SH "FLAGS"
+.nf
+\-\-set\-labels=METADATA
+    Metadata of deployment that contains any information which can
+    be usefull for filtering deployments\.
+.fi
 .SH "UFFIZZI WIDE FLAGS"
 .nf
 These flags are available to all commands: \-\-project\. Run $ uffizzi
@@ -46,5 +52,14 @@ To create a preview with the project\'s default compose file, run:
 To create a preview with an alternate compose file, run:
 
     $ uffizzi preview create docker\-compose\.uffizzi\.alt\.yml
+
+To create a preview with single label, run:
+
+    $ uffizzi preview create \-\-set\-labels github\.repo=my_repo
+
+To create a preview with multiple labels, run:
+
+    $ uffizzi preview create \e
+    \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
 .fi