uffizzi-cli 2.0.34 → 2.0.35

data/man/uffizzi-compose-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-compose-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-compose-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\-COMPOSE\-SERVICE\-LIST" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-compose\-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-compose-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-compose-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\-COMPOSE\-SERVICE\-LOGS" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-compose\-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-compose-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

data/man/uffizzi-compose-update

@@ -0,0 +1,61 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UPDATE" "" "August 2023" ""
+.SH "NAME"
+\fBupdate\fR \- update a compose environment (preview)
+.SH "SYNOPSIS"
+.nf
+uffizzi compose update [COMPOSE_ENVIRONMENT_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Given a compose environment (preview) ID and new compose file,
+update a compose environment (preview)\. Updating a compose
+environment (preview) does not change its compose environment (preview) URL\.
+
+This command can fail for the following reasons:
+    \- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
+    \- The COMPOSE_FILE specified is invalid
+
+For more information on Uffizzi previews, 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 update\.
+
+[COMPOSE_FILE]
+    The new compose file you want to compose environment (preview)\.
+.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
+The following command updates a compose environment (preview)
+with ID deployment\-67 using compose file docker\-compose\.alt\.yml:
+
+    $ uffizzi compose update deployment\-67 docker\-compose\.alt\.yml
+
+To update a compose with single label, run:
+
+    $ uffizzi compose update \e
+    deployment\-67 docker\-compose\.alt\.yml \e
+    \-\-set\-labels github\.repo=my_repo
+
+To update a compose with multiple labels, run:
+
+    $ uffizzi compose update \e
+    deployment\-67 docker\-compose\.alt\.yml \e
+    \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
+.fi
+

data/man/uffizzi-compose-update.ronn

@@ -0,0 +1,51 @@
+uffizzi compose update - update a compose environment (preview)
+================================================================
+
+## SYNOPSIS
+    uffizzi compose update [COMPOSE_ENVIRONMENT_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Given a compose environment (preview) ID and new compose file,
+    update a compose environment (preview). Updating a compose
+    environment (preview) does not change its compose environment (preview) URL.
+
+    This command can fail for the following reasons:
+        - There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
+        - The COMPOSE_FILE specified is invalid
+
+    For more information on Uffizzi previews, see:
+    https://docs.uffizzi.com/references/cli/
+
+## POSITIONAL ARGUMENTS
+    [COMPOSE_ENVIRONMENT_ID]
+        The ID of the compose environment (preview) that you want to update.
+
+    [COMPOSE_FILE]
+        The new compose file you want to compose environment (preview).
+
+## 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
+    The following command updates a compose environment (preview)
+    with ID deployment-67 using compose file docker-compose.alt.yml:
+
+        $ uffizzi compose update deployment-67 docker-compose.alt.yml
+
+    To update a compose with single label, run:
+
+        $ uffizzi compose update \
+        deployment-67 docker-compose.alt.yml \
+        --set-labels github.repo=my_repo
+
+    To update a compose with multiple labels, run:
+
+        $ uffizzi compose update \
+        deployment-67 docker-compose.alt.yml \
+        --set-labels="github.repo=my_repo github.pull_request.number=23"

data/man/uffizzi-compose.ronn

@@ -0,0 +1,33 @@
+uffizzi-compose - manage previews
+================================================================
+
+## SYNOPSIS
+    uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Manage Uffizzi previews
+
+    For more information on Uffizzi previews, 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 compose environment (preview)
+
+     delete
+        Delete a compose environment (preview)
+
+     describe
+        Display details of a compose environment (preview)
+
+     list
+        List all compose environments (previews)
+
+##
+Run 'uffizzi compose COMMAND --help' for more information on a command.

data/man/uffizzi-compose_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\-COMPOSE_SERVICE_LOGS" "" "August 2023" ""
+.SH "NAME"
+\fBuffizzi\-compose_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-compose_service_logs.ronn

@@ -0,0 +1,50 @@
+  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
+

data/man/uffizzi-config

@@ -0,0 +1,65 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "CONFIG" "" "August 2023" ""
+.SH "NAME"
+\fBconfig\fR \- configure the Uffizzi command\-line interface (CLI)
+.SH "SYNOPSIS"
+.nf
+uffizzi config COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+The uffizzi config command lets you configure this command\-line application\.
+If COMMAND is not specified, uffizzi config launches an interactive set up
+guide\.
+
+For more information on configuration options, 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:
+
+ get\-value OPTION
+    Displays the value of the specified option\.
+
+ list
+    Lists all options and their values from the config file\.
+
+ set OPTION VALUE
+    Sets the value of the specified option\.
+
+ unset OPTION
+    Deletes the value of the specified option\.
+.fi
+.SH "OPTIONS"
+.nf
+ OPTION is one of the following:
+
+ server
+    The server of the Uffizzi API service you want to access\. Defaults to
+    app\.uffizzi\.com\.
+
+ name
+    Your name\.
+
+ project
+    The current active project\. This project is used as the default unless
+    \-\-project is pass as an argument\.
+.fi
+.SH "EXAMPLES"
+.nf
+To list the uffizzi configuration options, run:
+
+    $ uffizzi config list
+
+To set a new current active project for uffizzi, run:
+
+    $ uffizzi config set project my\-project
+.fi
+

data/man/uffizzi-config.ronn

@@ -0,0 +1,55 @@
+uffizzi config - configure the Uffizzi command-line interface (CLI)
+================================================================
+
+## SYNOPSIS
+    uffizzi config COMMAND [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    The uffizzi config command lets you configure this command-line application.
+    If COMMAND is not specified, uffizzi config launches an interactive set up
+    guide.
+
+    For more information on configuration options, 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:
+
+     get-value OPTION
+        Displays the value of the specified option.  
+
+     list
+        Lists all options and their values from the config file.
+
+     set OPTION VALUE
+        Sets the value of the specified option.
+
+     unset OPTION
+        Deletes the value of the specified option.    
+
+## OPTIONS
+     OPTION is one of the following: 
+     
+     server
+        The server of the Uffizzi API service you want to access. Defaults to 
+        app.uffizzi.com.
+
+     name
+        Your name.
+
+     project
+        The current active project. This project is used as the default unless 
+        --project is pass as an argument.
+
+## EXAMPLES
+    To list the uffizzi configuration options, run:
+
+        $ uffizzi config list
+
+    To set a new current active project for uffizzi, run:
+
+        $ uffizzi config set project my-project