uffizzi-cli 2.0.34 → 2.0.35

data/man/uffizzi-project-preview-set

@@ -0,0 +1,66 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-COMPOSE\-SET" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-compose\-set\fR \- sets the configuration of a project with a compose file
+.SH "SYNOPSIS"
+.nf
+uffizzi project compose set [\-\-repository=REPOSITORY]
+     [\-\-branch=BRANCH] [\-\-path=PATH_TO_COMPOSE_FILE]
+     [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+By default, sets the configuration of the default project with the
+specified compose file\. Use the \-\-project flag to set the compose
+file of a different project\. If already set, this command overrides
+the project\'s configuration with the new compose file\. The compose
+file must exist within a GitHub repository\.
+
+This command can fail for the following reasons:
+    \- The repository, branch, or path to the compose file as
+      specified does not exist\.
+    \- uffizzi is not authorized to access the repository\.
+      Run $ uffizzi connect \-\-help for details about connecting to
+      external services\.
+    \- The compose file is invalid\.
+
+For more information on the uffizzi project compose command, see:
+https://docs\.uffizzi\.com/references/cli/
+
+For more information on the Uffizzi Compose specification, see:
+https://docs\.uffizzi\.com/references/compose\-spec
+.fi
+.SH "FLAGS"
+.nf
+\-\-repository=REPOSITORY
+    The repository that contains the compose file you want to set
+    for a project\.
+
+\-\-branch=BRANCH
+    The branch of the repository that contains the compose file you
+    want to set for a project\. If not specified, the default branch
+    as configured on GitHub is used\.
+
+\-\-path=PATH_TO_COMPOSE_FILE
+    The path to the compose file that you want to set for a project\.
+    This compose file is used as the default when creating previews\.
+    Run $ uffizzi preview \-\-help for details\.
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+The following command sets a compose file for the default project\.
+The compose file (docker\-compose\.uffizzi\.yml) exists in the main
+branch of a GitHub repository called example\-app:
+
+    $ uffizzi project compose set \e
+      \-\-repository="github\.com/example/example\-app" \e
+      \-\-branch="main" \e
+      \-\-path="app/docker\-compose\.uffizzi\.yml"
+.fi
+

data/man/uffizzi-project-preview-set.ronn

@@ -0,0 +1,57 @@
+  uffizzi-project-compose-set - sets the configuration of a project with a compose file
+================================================================
+
+## SYNOPSIS
+    uffizzi project compose set [--repository=REPOSITORY] 
+         [--branch=BRANCH] [--path=PATH_TO_COMPOSE_FILE] 
+         [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    By default, sets the configuration of the default project with the
+    specified compose file. Use the --project flag to set the compose 
+    file of a different project. If already set, this command overrides 
+    the project's configuration with the new compose file. The compose 
+    file must exist within a GitHub repository. 
+
+    This command can fail for the following reasons:  
+        - The repository, branch, or path to the compose file as 
+          specified does not exist.
+        - uffizzi is not authorized to access the repository. 
+          Run $ uffizzi connect --help for details about connecting to
+          external services.
+        - The compose file is invalid.
+
+    For more information on the uffizzi project compose command, see:
+    https://docs.uffizzi.com/references/cli/
+
+    For more information on the Uffizzi Compose specification, see:
+    https://docs.uffizzi.com/references/compose-spec
+
+## FLAGS
+    --repository=REPOSITORY
+        The repository that contains the compose file you want to set 
+        for a project. 
+
+    --branch=BRANCH
+        The branch of the repository that contains the compose file you
+        want to set for a project. If not specified, the default branch 
+        as configured on GitHub is used.
+
+    --path=PATH_TO_COMPOSE_FILE
+        The path to the compose file that you want to set for a project.
+        This compose file is used as the default when creating previews.
+        Run $ uffizzi preview --help for details. 
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command sets a compose file for the default project.
+    The compose file (docker-compose.uffizzi.yml) exists in the main 
+    branch of a GitHub repository called example-app:
+
+        $ uffizzi project compose set \
+          --repository="github.com/example/example-app" \
+          --branch="main" \
+          --path="app/docker-compose.uffizzi.yml"

data/man/uffizzi-project-secret

@@ -0,0 +1,37 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-SECRET" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-secret\fR \- manage secrets for a project
+.SH "SYNOPSIS"
+.nf
+uffizzi project secret COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Manage secrets for a project\. Once added, project secrets cannot
+be viewed or edited\.
+
+For more information on secrets, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "COMMANDS"
+.nf
+COMMAND is one of the following:
+
+ create
+    Create a secret for a project
+
+ delete
+    Delete a secret for a project
+
+ list
+    Show metadata for all secrets of a project
+.fi
+.P
+Run $ uffizzi project secret COMMAND \-\-help for more information on a command\.

data/man/uffizzi-project-secret-create

@@ -0,0 +1,29 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-SECRET\-CREATE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-secret\-create\fR \- Creates a secret from STDIN
+.SH "SYNOPSIS"
+.nf
+uffizzi project secret create SECRET [\-] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Creates a secret from STDIN
+
+For more information on the uffizzi project secret command, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+The following command creates a secret called MY_SECRET from STDIN
+in the default project:
+
+    $ printf "my secret password" | uffizzi project secret create MY_SECRET
+.fi
+

data/man/uffizzi-project-secret-create.ronn

@@ -0,0 +1,21 @@
+  uffizzi-project-secret-create - Creates a secret from STDIN 
+================================================================
+
+## SYNOPSIS
+    uffizzi project secret create SECRET [-] [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    Creates a secret from STDIN
+
+    For more information on the uffizzi project secret command, see:
+    https://docs.uffizzi.com/references/cli/
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command creates a secret called MY_SECRET from STDIN 
+    in the default project:
+
+        $ printf "my secret password" | uffizzi project secret create MY_SECRET

data/man/uffizzi-project-secret-delete

@@ -0,0 +1,29 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-SECRET\-DELETE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-secret\-delete\fR \- deletes a secret
+.SH "SYNOPSIS"
+.nf
+uffizzi project secret delete [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Deletes a secret
+
+For more information on the uffizzi project secret command, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+The following command deletes the secret MY_SECRET in the default
+project:
+
+    $ uffizzi project secret delete MY_SECRET
+.fi
+

data/man/uffizzi-project-secret-delete.ronn

@@ -0,0 +1,21 @@
+  uffizzi-project-secret-delete - deletes a secret
+================================================================
+
+## SYNOPSIS
+    uffizzi project secret delete [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    Deletes a secret
+    
+    For more information on the uffizzi project secret command, see:
+    https://docs.uffizzi.com/references/cli/
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command deletes the secret MY_SECRET in the default
+    project: 
+
+        $ uffizzi project secret delete MY_SECRET

data/man/uffizzi-project-secret-list

@@ -0,0 +1,28 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-SECRET\-LIST" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-secret\-list\fR \- lists metadata for all secrets in a project
+.SH "SYNOPSIS"
+.nf
+uffizzi project secret list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Lists metadata for all secrets in a project
+
+For more information on the uffizzi project secret command, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+The following command lists all secrets in the default project:
+
+    $ uffizzi project secret list
+.fi
+

data/man/uffizzi-project-secret-list.ronn

@@ -0,0 +1,20 @@
+  uffizzi-project-secret-list - lists metadata for all secrets in a project
+================================================================
+
+## SYNOPSIS
+    uffizzi project secret list [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    Lists metadata for all secrets in a project
+    
+    For more information on the uffizzi project secret command, see:
+    https://docs.uffizzi.com/references/cli/
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command lists all secrets in the default project:
+
+        $ uffizzi project secret list

data/man/uffizzi-project-secret.ronn

@@ -0,0 +1,30 @@
+  uffizzi-project-secret - manage secrets for a project
+================================================================
+
+## SYNOPSIS
+    uffizzi project secret COMMAND [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Manage secrets for a project. Once added, project secrets cannot 
+    be viewed or edited. 
+
+    For more information on secrets, see:
+    https://docs.uffizzi.com/references/cli/
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## COMMANDS
+    COMMAND is one of the following:
+
+     create
+        Create a secret for a project
+
+     delete
+        Delete a secret for a project
+
+     list
+        Show metadata for all secrets of a project
+
+Run $ uffizzi project secret COMMAND --help for more information on a command.

data/man/uffizzi-project-set-default

@@ -0,0 +1,34 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-SET\-DEFAULT" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-set\-default\fR \- set the default project for the active account
+.SH "SYNOPSIS"
+.nf
+uffizzi project set\-default PROJECT_SLUG [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Sets the default project given with the given project slug\. When set,
+all commands use this project as the default context unless
+overridden by the \-\-project flag\.
+
+This command can fail for the following reasons:
+  \- There is no project with the given project slug
+
+For more information on Uffizzi projects, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+The following sets the default project with project slug
+example\-foo\-9suw4 for the active account:
+
+    $ uffizzi project set\-default example\-foo\-9suw4
+.fi
+

data/man/uffizzi-project-set-default.ronn

@@ -0,0 +1,26 @@
+uffizzi-project-set-default - set the default project for the active account
+================================================================
+
+## SYNOPSIS
+    uffizzi project set-default PROJECT_SLUG [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Sets the default project given with the given project slug. When set, 
+    all commands use this project as the default context unless 
+    overridden by the --project flag.
+
+    This command can fail for the following reasons:
+      - There is no project with the given project slug
+
+    For more information on Uffizzi projects, see:
+    https://docs.uffizzi.com/references/cli/
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following sets the default project with project slug 
+    example-foo-9suw4 for the active account:
+
+        $ uffizzi project set-default example-foo-9suw4

data/man/uffizzi-project.html

@@ -0,0 +1,124 @@
+<!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>manage Uffizzi projects</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="#COMMANDS">COMMANDS</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>uffizzi-project</li>
+    <li class='tc'></li>
+    <li class='tr'>uffizzi-project</li>
+  </ol>
+
+  
+
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>uffizzi-project</code> - <span class="man-whatis">manage Uffizzi projects</span>
+</p>
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+<pre><code>uffizzi project COMMAND [UFFIZZI_WIDE_FLAG ...]
+</code></pre>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+<pre><code>Manage Uffizzi projects
+
+For more information on Uffizzi projects, see:
+https://github.com/UffizziCloud/uffizzi_cli
+</code></pre>
+
+<h2 id="COMMANDS">COMMANDS</h2>
+<pre><code>COMMAND is one of the following:
+
+ compose
+    Manage the compose file for a project.
+
+ create
+    Create a new project.
+
+ delete
+    Delete a project.
+
+ describe
+    Display project meta data.
+
+ list
+    List all projects in the account.
+
+ secret
+    Manage secrets for a project.
+
+ set-default
+    Set the default project in the uffizzi configuration. Also see
+    $ uffizzi config help for details.
+
+ update OPTIONS
+    Update a project's metadata.
+</code></pre>
+
+<p>Run $ uffizzi project COMMAND --help for more information on a command.</p>
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>July 2023</li>
+    <li class='tr'>uffizzi-project</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/uffizzi-project.ronn

@@ -0,0 +1,41 @@
+  uffizzi-project - manage Uffizzi projects
+================================================================
+
+## SYNOPSIS
+    uffizzi project COMMAND [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Manage Uffizzi projects
+
+    For more information on Uffizzi projects, see:
+    https://docs.uffizzi.com/references/cli/
+
+## COMMANDS
+    COMMAND is one of the following:
+
+     compose
+        Manage the compose file for a project.
+
+     create
+        Create a new project.
+
+     delete
+        Delete a project.
+
+     describe
+        Display project meta data.
+
+     list
+        List all projects in the account.
+
+     secret
+        Manage secrets for a project.
+
+     set-default
+        Set the default project in the uffizzi configuration. Also see
+        $ uffizzi config help for details.
+
+     update OPTIONS
+        Update a project's metadata.
+
+Run $ uffizzi project COMMAND --help for more information on a command.