uffizzi-cli 2.0.34 → 2.0.35

data/man/uffizzi-project-compose

@@ -0,0 +1,40 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-COMPOSE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-compose\fR \- manage the compose file for a project
+.SH "SYNOPSIS"
+.nf
+uffizzi project compose COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+By default, manages the compose file for the default project\. Use the
+\-\-project flag to manage the compose file of a different project\.
+
+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 "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:
+
+ set
+    Set the configuration of a project with a compose file\.
+
+ describe
+    Display details of a compose file\.
+
+ unset
+    Unset the compose file for a project\.
+.fi
+.P
+Run ‘uffizzi project compose COMMAND \-\-help’ for more information on a command\.

data/man/uffizzi-project-compose-describe

@@ -0,0 +1,37 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-COMPOSE\-DESCRIBE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-compose\-describe\fR \- show metadata for a compose file
+.SH "SYNOPSIS"
+.nf
+uffizzi project compose describe [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+By default, shows the contents of the default project’s compose
+file\. Use the \-\-project flag to describe the compose file of a
+different project\.
+
+This command can fail for the following reasons:
+    \- A compose file is not set for the project\.
+
+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 "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+The following command prints the contents of the default project’s
+compose file:
+
+    $ uffizzi project compose describe
+.fi
+

data/man/uffizzi-project-compose-describe.ronn

@@ -0,0 +1,29 @@
+  uffizzi-project-compose-describe - show metadata for a compose file
+================================================================
+
+## SYNOPSIS
+    uffizzi project compose describe [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    By default, shows the contents of the default project’s compose 
+    file. Use the --project flag to describe the compose file of a
+    different project.
+
+    This command can fail for the following reasons:
+        - A compose file is not set for the project.
+    
+    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
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command prints the contents of the default project’s 
+    compose file: 
+
+        $ uffizzi project compose describe

data/man/uffizzi-project-compose-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-compose-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-compose-unset

@@ -0,0 +1,35 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-COMPOSE\-UNSET" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-compose\-unset\fR \- unset the compose file for a project
+.SH "SYNOPSIS"
+.nf
+uffizzi project compose unset [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+By default, unsets the compose file for the default project\. Use the
+\-\-project flag to unset the compose file of a different project\.
+
+This command can fail for the following reasons:
+    \- A compose file is not set for the project\.
+
+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 "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+The following command unsets the default project’s compose file:
+
+    $ uffizzi project compose unset
+.fi
+

data/man/uffizzi-project-compose-unset.ronn

@@ -0,0 +1,27 @@
+  uffizzi-project-compose-unset - unset the compose file for a project
+================================================================
+
+## SYNOPSIS
+    uffizzi project compose unset [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    By default, unsets the compose file for the default project. Use the 
+    --project flag to unset the compose file of a different project.
+
+    This command can fail for the following reasons:
+        - A compose file is not set for the project.
+    
+    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
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command unsets the default project’s compose file:
+
+        $ uffizzi project compose unset

data/man/uffizzi-project-compose.ronn

@@ -0,0 +1,34 @@
+  uffizzi-project-compose - manage the compose file for a project
+================================================================
+
+## SYNOPSIS
+    uffizzi project compose COMMAND [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    By default, manages the compose file for the default project. Use the 
+    --project flag to manage the compose file of a different project.
+
+    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
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## COMMANDS
+    COMMAND is one of the following:
+
+     set
+        Set the configuration of a project with a compose file.
+
+     describe
+        Display details of a compose file. 
+
+     unset
+        Unset the compose file for a project.
+
+Run ‘uffizzi project compose COMMAND --help’ for more information on a 
+command.

data/man/uffizzi-project-create

@@ -0,0 +1,50 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-CREATE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-create\fR \- create a new project
+.SH "SYNOPSIS"
+.nf
+uffizzi project create [\-\-name=NAME] [\-\-slug=SLUG]
+     [\-\-description=DESCRIPTION] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Create new project\.
+
+This command can fail for the following reasons:
+    \- The project \-\-description is too long\.
+    \- The project \-\-name flag is not specified\.
+    \- The project \-\-slug is malformed or used by another project\.
+
+For more information on the uffizzi project command, see:
+https:/docs\.uffizzi\.com/references/cli/
+.fi
+.SH "FLAGS"
+.nf
+\-\-description=DESCRIPTION
+   Description for the project you want to create\. Max of 256
+   characters\.
+
+\-\-name=NAME
+   Name for the project you want to create\.
+
+\-\-slug=SLUG
+   A URL\-compatible name\. Do not include whitespaces or special characters\.
+   Project slugs must be globally unique across all Uffizzi projects\.
+   If a slug is not provided, Uffizzi will automatically generate one\.
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+To create a new project with name My App, project slug my\-app, and
+description "My first project", run:
+
+    $ uffizzi project create \-\-name="My App" \-\-slug="my\-app" \e
+      \-\-description="My first project"
+.fi
+

data/man/uffizzi-project-create.ronn

@@ -0,0 +1,41 @@
+uffizzi-project-create - create a new project
+================================================================
+
+## SYNOPSIS
+    uffizzi project create [--name=NAME] [--slug=SLUG]
+         [--description=DESCRIPTION] [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    Create new project.
+
+    This command can fail for the following reasons:  
+        - The project --description is too long.
+        - The project --name flag is not specified.
+        - The project --slug is malformed or used by another project. 
+
+    For more information on the uffizzi project command, see:
+    https:/docs.uffizzi.com/references/cli/
+
+## FLAGS
+    --description=DESCRIPTION
+       Description for the project you want to create. Max of 256 
+       characters.
+
+    --name=NAME
+       Name for the project you want to create. 
+
+    --slug=SLUG
+       A URL-compatible name. Do not include whitespaces or special characters.
+       Project slugs must be globally unique across all Uffizzi projects.
+       If a slug is not provided, Uffizzi will automatically generate one.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    To create a new project with name My App, project slug my-app, and
+    description "My first project", run:
+
+        $ uffizzi project create --name="My App" --slug="my-app" \
+          --description="My first project"

data/man/uffizzi-project-delete

@@ -0,0 +1,32 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-DELETE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-delete\fR \- delete a project
+.SH "SYNOPSIS"
+.nf
+uffizzi project delete PROJECT_SLUG [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Deletes a project with the given project slug\.
+
+This command can fail for the following reasons:
+  \- There is no project with the given project slug
+  \- The active account does not have permission to delete the project
+
+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
+To delete a project with project slug my\-app\-xc8fw, run:
+
+    $ uffizzi project delete my\-app\-xc8fw
+.fi
+

data/man/uffizzi-project-delete.ronn

@@ -0,0 +1,24 @@
+uffizzi-project-delete - delete a project
+================================================================
+
+## SYNOPSIS
+    uffizzi project delete PROJECT_SLUG [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Deletes a project with the given project slug. 
+
+    This command can fail for the following reasons:
+      - There is no project with the given project slug
+      - The active account does not have permission to delete the project
+
+    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
+    To delete a project with project slug my-app-xc8fw, run:
+
+        $ uffizzi project delete my-app-xc8fw

data/man/uffizzi-project-describe

@@ -0,0 +1,43 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "DESCRIBE" "" "August 2023" ""
+.SH "NAME"
+\fBdescribe\fR \- show metadata for a project
+.SH "SYNOPSIS"
+.nf
+uffizzi project describe PROJECT_SLUG [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Shows metadata for a project given a valid project slug\.
+
+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
+\-\-output FORMAT
+   Output format\. FORMAT is one of the following: json, pretty
+   Default is json\.
+.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 prints metadata in json format for a project with the
+project slug my\-app\-xc8fw:
+
+    $ uffizzi project describe my\-app\-xc8fw
+
+The following command pretty prints metadata for a project with the project
+slug my\-app\-xc8fw:
+
+    $ uffizzi project describe my\-app\-xc8fw \-\-output pretty
+.fi
+

data/man/uffizzi-project-describe.ronn

@@ -0,0 +1,34 @@
+  uffizzi project describe - show metadata for a project
+================================================================
+
+## SYNOPSIS
+    uffizzi project describe PROJECT_SLUG [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Shows metadata for a project given a valid project slug. 
+
+    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
+    --output FORMAT
+       Output format. FORMAT is one of the following: json, pretty 
+       Default is json.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command prints metadata in json format for a project with the 
+    project slug my-app-xc8fw:
+
+        $ uffizzi project describe my-app-xc8fw
+
+    The following command pretty prints metadata for a project with the project
+    slug my-app-xc8fw:
+
+        $ uffizzi project describe my-app-xc8fw --output pretty 

data/man/uffizzi-project-preview-describe

@@ -0,0 +1,37 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-COMPOSE\-DESCRIBE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-project\-compose\-describe\fR \- show metadata for a compose file
+.SH "SYNOPSIS"
+.nf
+uffizzi project compose describe [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+By default, shows the contents of the default project’s compose
+file\. Use the \-\-project flag to describe the compose file of a
+different project\.
+
+This command can fail for the following reasons:
+    \- A compose file is not set for the project\.
+
+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 "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+The following command prints the contents of the default project’s
+compose file:
+
+    $ uffizzi project compose describe
+.fi
+

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

@@ -0,0 +1,29 @@
+  uffizzi-project-compose-describe - show metadata for a compose file
+================================================================
+
+## SYNOPSIS
+    uffizzi project compose describe [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    By default, shows the contents of the default project’s compose 
+    file. Use the --project flag to describe the compose file of a
+    different project.
+
+    This command can fail for the following reasons:
+        - A compose file is not set for the project.
+    
+    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
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command prints the contents of the default project’s 
+    compose file: 
+
+        $ uffizzi project compose describe