uffizzi-cli 2.0.34 → 2.0.36

data/man/uffizzi-preview

@@ -0,0 +1,39 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-COMPOSE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-compose\fR \- manage previews
+.SH "SYNOPSIS"
+.nf
+uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Manage Uffizzi previews
+
+For more information on Uffizzi previews, 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 compose environment (preview)
+
+ delete
+    Delete a compose environment (preview)
+
+ describe
+    Display details of a compose environment (preview)
+
+ list
+    List all compose environments (previews)
+.fi
+.SH "Run \'uffizzi compose COMMAND \-\-help\' for more information on a command\."
+

data/man/uffizzi-preview-create

@@ -0,0 +1,67 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-COMPOSE\-CREATE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-compose\-create\fR \- create a compose environment (preview)
+.SH "SYNOPSIS"
+.nf
+uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Creates a new compose environment (preview)\. If no COMPOSE_FILE is specified,
+the compose environment (preview) is created with the project\'s default compose file\.
+Run $ uffizzi project compose \-\-help for details\.
+
+This command can fail for the following reasons:
+    \- The project does not have a default compose file set\. Run
+      $ uffizzi compose \-\-help for details\.
+    \- The alternate compose file is invalid\.
+
+For more information on Uffizzi previews, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "POSITIONAL ARGUMENTS"
+.nf
+[COMPOSE_FILE]
+    An alternate compose file to the default compose\.
+
+    You can pass a compose file to this command to create an ad hoc
+    compose environment (preview) of an alternate compose configuration\.
+    The file passed via this argument does not replace the default
+    compose file for the project\. Alternate compose files share the
+    same lifecyle as the previews they create: when the compose
+    environment (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 useful for filtering deployments\.
+.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 compose environment (preview) with the project\'s default compose file, run:
+
+    $ uffizzi compose create
+
+To create a compose environment (preview) with an alternate compose file, run:
+
+    $ uffizzi compose create docker\-compose\.uffizzi\.alt\.yml
+
+To create a compose environment (preview) with single label, run:
+
+    $ uffizzi compose create \-\-set\-labels github\.repo=my_repo
+
+To create a compose environment (preview) with multiple labels, run:
+
+    $ uffizzi compose create \e
+    \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
+.fi
+

data/man/uffizzi-preview-create.ronn

@@ -0,0 +1,57 @@
+uffizzi-compose-create - create a compose environment (preview)
+================================================================
+
+## SYNOPSIS
+    uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Creates a new compose environment (preview). If no COMPOSE_FILE is specified,
+    the compose environment (preview) is created with the project's default compose file.
+    Run $ uffizzi project compose --help for details.
+
+    This command can fail for the following reasons:
+        - The project does not have a default compose file set. Run
+          $ uffizzi compose --help for details.
+        - The alternate compose file is invalid.
+
+    For more information on Uffizzi previews, see:
+    https://docs.uffizzi.com/references/cli/
+
+## POSITIONAL ARGUMENTS
+    [COMPOSE_FILE]
+        An alternate compose file to the default compose.
+
+        You can pass a compose file to this command to create an ad hoc
+        compose environment (preview) of an alternate compose configuration.
+        The file passed via this argument does not replace the default
+        compose file for the project. Alternate compose files share the
+        same lifecyle as the previews they create: when the compose
+        environment (preview) is deleted, the alternate compose
+        is deleted by the Uffizzi API.
+
+## FLAGS
+    --set-labels=METADATA
+        Metadata of deployment that contains any information which can
+        be useful for filtering deployments.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi
+    help for details.
+
+## EXAMPLES
+    To create a compose environment (preview) with the project's default compose file, run:
+
+        $ uffizzi compose create
+
+    To create a compose environment (preview) with an alternate compose file, run:
+
+        $ uffizzi compose create docker-compose.uffizzi.alt.yml
+
+    To create a compose environment (preview) with single label, run:
+
+        $ uffizzi compose create --set-labels github.repo=my_repo
+
+    To create a compose environment (preview) with multiple labels, run:
+
+        $ uffizzi compose create \
+        --set-labels="github.repo=my_repo github.pull_request.number=23"

data/man/uffizzi-preview-delete

@@ -0,0 +1,38 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-COMPOSE\-DELETE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-compose\-delete\fR \- delete a compose environment (preview)
+.SH "SYNOPSIS"
+.nf
+uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Deletes a compose environment (preview) with
+the given compose environment (preview) ID\.
+
+This command can fail for the following reasons:
+    \- The compose environment (preview) specified does not exist\.
+    \- The compose environment (preview) specified belongs to a different project\.
+
+For more information on Uffizzi previews, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "POSITIONAL ARGUMENTS"
+.nf
+[PREVIEW_ID]
+    ID for the compose environment (preview) you want to delete\.
+.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 compose environment (preview) with ID deployment\-213:
+
+    $ uffizzi compose delete deployment\-213
+.fi
+

data/man/uffizzi-preview-delete.ronn

@@ -0,0 +1,29 @@
+uffizzi-compose-delete - delete a compose environment (preview)
+================================================================
+
+## SYNOPSIS
+    uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Deletes a compose environment (preview) with
+    the given compose environment (preview) ID.
+
+    This command can fail for the following reasons:
+        - The compose environment (preview) specified does not exist.
+        - The compose environment (preview) specified belongs to a different project.
+
+    For more information on Uffizzi previews, see:
+    https://docs.uffizzi.com/references/cli/
+
+## POSITIONAL ARGUMENTS
+    [PREVIEW_ID]
+        ID for the compose environment (preview) you want to delete.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi
+    help for details.
+
+## EXAMPLES
+    The following command deletes the compose environment (preview) with ID deployment-213:
+
+        $ uffizzi compose delete deployment-213

data/man/uffizzi-preview-describe

@@ -0,0 +1,38 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-COMPOSE\-DESCRIBE" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-compose\-describe\fR \- show metadata for a compose environment (preview)
+.SH "SYNOPSIS"
+.nf
+uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Shows metadata for a project given a valid compose environment (preview) ID\.
+
+This command can fail for the following reasons:
+    \- The compose environment (preview) specified does not exist\.
+    \- The compose environment (preview) specified belongs to a different project\.
+
+For more information on Uffizzi previews, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "POSITIONAL ARGUMENTS"
+.nf
+[PREVIEW_ID]
+    ID for the compose environment (preview) you want to describe\.
+.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 for the compose environment (preview) with ID
+deployment\-213:
+
+    $ uffizzi compose describe deployment\-213
+.fi
+

data/man/uffizzi-preview-describe.ronn

@@ -0,0 +1,29 @@
+uffizzi-compose-describe - show metadata for a compose environment (preview)
+================================================================
+
+## SYNOPSIS
+    uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Shows metadata for a project given a valid compose environment (preview) ID.
+
+    This command can fail for the following reasons:
+        - The compose environment (preview) specified does not exist.
+        - The compose environment (preview) specified belongs to a different project.
+
+    For more information on Uffizzi previews, see:
+    https://docs.uffizzi.com/references/cli/
+
+## POSITIONAL ARGUMENTS
+    [PREVIEW_ID]
+        ID for the compose environment (preview) you want to describe.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi
+    help for details.
+
+## EXAMPLES
+    The following command prints metadata for the compose environment (preview) with ID
+    deployment-213:
+
+        $ uffizzi compose describe deployment-213

data/man/uffizzi-preview-events

@@ -0,0 +1,38 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-COMPOSE\-EVENTS" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-compose\-events\fR \- show the deployment event logs for a compose environment (preview)
+.SH "SYNOPSIS"
+.nf
+uffizzi compose events [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Shows the deployment event logs for a given compose environment (preview)\.
+
+This command can fail for the following reasons:
+    \- There is no compose environment (preview) with
+      the given compose environment (preview) ID
+
+For more information on event logs, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "POSITIONAL ARGUMENTS"
+.nf
+[COMPOSE_ENVIRONMENT_ID]
+    The ID of the compose environment (preview) that you want to see events for\.
+.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 shows deployment events for
+the compose environment (preview) with ID deployment\-67:
+
+    $ uffizzi compose events deployment\-67
+.fi
+

data/man/uffizzi-preview-events.ronn

@@ -0,0 +1,29 @@
+uffizzi-compose-events - show the deployment event logs for a compose environment (preview)
+================================================================
+
+## SYNOPSIS
+    uffizzi compose events [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Shows the deployment event logs for a given compose environment (preview).
+
+    This command can fail for the following reasons:
+        - There is no compose environment (preview) with
+          the given compose environment (preview) ID
+
+    For more information on event logs, see:
+    https://docs.uffizzi.com/references/cli/
+
+## POSITIONAL ARGUMENTS
+    [COMPOSE_ENVIRONMENT_ID]
+        The ID of the compose environment (preview) that you want to see events for.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi
+    help for details.
+
+## EXAMPLES
+    The following command shows deployment events for
+    the compose environment (preview) with ID deployment-67:
+
+        $ uffizzi compose events deployment-67

data/man/uffizzi-preview-list

@@ -0,0 +1,58 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-COMPOSE\-LIST" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-compose\-list\fR \- list compose environments (previews) in a project
+.SH "SYNOPSIS"
+.nf
+uffizzi compose list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Lists all compose environments (previews) for a project,
+including active, building, deploying and failed compose
+environments (previews)\.
+
+For more information on Uffizzi compose environments (previews), see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "FLAGS"
+.nf
+\-\-filter=METADATA
+    Metadata to filter list of deployments\.
+
+\-\-output=pretty\-json
+    Use this option for a more detailed description of listed
+    deployments\.
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+To list all compose environments (previews) in the default project, run:
+
+    $ uffizzi compose list
+
+To list all compose environments (previews) in a project with name my_project, run:
+
+    $ uffizzi compose list \-\-project="my_project"
+
+To list all compose environments (previews) in json format, run:
+
+    $ uffizzi compose list \-\-output="pretty\-json"
+
+To list all compose environments (previews) filtered by metadata using single
+label, run:
+
+    $ uffizzi compose list \-\-filter github\.repo=my_repo
+
+To list all compose environments (previews) filtered by metadata using multiple
+labels, run:
+
+    $ uffizzi compose list \e
+    \-\-filter="github\.repo=my_repo github\.pull_request\.number=23"
+.fi
+

data/man/uffizzi-preview-list.ronn

@@ -0,0 +1,49 @@
+uffizzi-compose-list - list compose environments (previews) in a project
+================================================================
+
+## SYNOPSIS
+    uffizzi compose list [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Lists all compose environments (previews) for a project,
+    including active, building, deploying and failed compose
+    environments (previews).
+
+    For more information on Uffizzi compose environments (previews), see:
+    https://docs.uffizzi.com/references/cli/
+
+## FLAGS
+    --filter=METADATA
+        Metadata to filter list of deployments.
+
+    --output=pretty-json
+        Use this option for a more detailed description of listed
+        deployments.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi
+    help for details.
+
+## EXAMPLES
+    To list all compose environments (previews) in the default project, run:
+
+        $ uffizzi compose list
+
+    To list all compose environments (previews) in a project with name my_project, run:
+
+        $ uffizzi compose list --project="my_project"
+
+    To list all compose environments (previews) in json format, run:
+
+        $ uffizzi compose list --output="pretty-json"
+
+    To list all compose environments (previews) filtered by metadata using single
+    label, run:
+
+        $ uffizzi compose list --filter github.repo=my_repo
+
+    To list all compose environments (previews) filtered by metadata using multiple
+    labels, run:
+
+        $ uffizzi compose list \
+        --filter="github.repo=my_repo github.pull_request.number=23"

data/man/uffizzi-preview-service-list

@@ -0,0 +1,42 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PREVIEW\-SERVICE\-LIST" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-preview\-service\-list\fR
+.P
+uffizzi\-compose\-service\-list \- list the container services of a given compose environment (preview) ================================================================
+.SH "SYNOPSIS"
+.nf
+uffizzi compose service list [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Shows a list of the container services that make up a given
+compose environment (preview) deployment\.
+
+This command can fail for the following reasons:
+    \- There is no compose environment (preview)
+      with the given COMPOSE_ENVIRONMENT_ID
+
+For more information on preview services, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "POSITIONAL ARGUMENTS"
+.nf
+[COMPOSE_ENVIRONMENT_ID]
+    The ID of the compose environment (preview) you want to list services for\.
+.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 the container services
+for a compose environment (preview) with
+COMPOSE_ENVIRONMENT_ID deployment\-56:
+
+    $ uffizzi compose service list deployment\-56
+.fi
+

data/man/uffizzi-preview-service-list.ronn

@@ -0,0 +1,32 @@
+  uffizzi-compose-service-list - list the container services
+  of a given compose environment (preview)
+================================================================
+
+## SYNOPSIS
+    uffizzi compose service list [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Shows a list of the container services that make up a given
+    compose environment (preview) deployment.
+
+    This command can fail for the following reasons:
+        - There is no compose environment (preview)
+          with the given COMPOSE_ENVIRONMENT_ID
+
+    For more information on preview services, see:
+    https://docs.uffizzi.com/references/cli/
+
+## POSITIONAL ARGUMENTS
+    [COMPOSE_ENVIRONMENT_ID]
+        The ID of the compose environment (preview) you want to list services for.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi
+    help for details.
+
+## EXAMPLES
+    The following command lists the container services
+    for a compose environment (preview) with
+    COMPOSE_ENVIRONMENT_ID deployment-56:
+
+        $ uffizzi compose service list deployment-56

data/man/uffizzi-preview-service-logs

@@ -0,0 +1,59 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PREVIEW\-SERVICE\-LOGS" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-preview\-service\-logs\fR
+.P
+uffizzi\-compose\-service\-logs \- show the logs for a container service of a compose environment (preview) ================================================================
+.SH "SYNOPSIS"
+.nf
+uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Shows the logs for a given container service of a given compose environment (preview)\.
+
+This command can fail for the following reasons:
+    \- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
+    \- There is no service with the name SERVICE
+
+For more information on service logs, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "LOG_TYPE"
+.nf
+LOG_TYPE is one of the following:
+
+build
+    The build logs of a service\.
+
+container
+    The container logs of a service\.
+.fi
+.SH "POSITIONAL ARGUMENTS"
+.nf
+[COMPOSE_ENVIRONMENT_ID]
+    The ID of the compose environment (preview) that includes the service you want to
+    show logs for\.
+
+[SERVICE]
+    The name of the service you want to show logs for\.
+.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 shows build logs for the service web\-app of the
+compose environment (preview) with ID deployment\-14:
+
+    $ uffizzi compose service logs build deployment\-14 web\-app
+
+The following command shows container logs for the service postgres\-db of
+the compose environment (preview) with ID deployment\-14:
+
+    $ uffizzi compose service logs container deployment\-14 postgres\-db
+.fi
+

data/man/uffizzi-preview-service-logs.ronn

@@ -0,0 +1,48 @@
+  uffizzi-compose-service-logs - show the logs for a container service
+  of a compose environment (preview)
+================================================================
+
+## SYNOPSIS
+    uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Shows the logs for a given container service of a given compose environment (preview).
+
+    This command can fail for the following reasons:
+        - There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
+        - There is no service with the name SERVICE
+
+    For more information on service logs, see:
+    https://docs.uffizzi.com/references/cli/
+
+## LOG_TYPE
+    LOG_TYPE is one of the following:
+
+    build
+        The build logs of a service.
+
+    container
+        The container logs of a service.
+
+## POSITIONAL ARGUMENTS
+    [COMPOSE_ENVIRONMENT_ID]
+        The ID of the compose environment (preview) that includes the service you want to
+        show logs for.
+
+    [SERVICE]
+        The name of the service you want to show logs for.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi
+    help for details.
+
+## EXAMPLES
+    The following command shows build logs for the service web-app of the
+    compose environment (preview) with ID deployment-14:
+
+        $ uffizzi compose service logs build deployment-14 web-app
+
+    The following command shows container logs for the service postgres-db of
+    the compose environment (preview) with ID deployment-14:
+
+        $ uffizzi compose service logs container deployment-14 postgres-db