Sha256: 74b4651bcb58ef3ff3568479baed37382c66b12b7bac5f800627e3e089fb11a8

Contents?: true

Size: 1.98 KB

Versions: 7

Compression:

Stored size: 1.98 KB

Contents

.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "UFFIZZI\-PREVIEW\-CREATE" "" "August 2022" ""
.SH "NAME"
\fBuffizzi\-preview\-create\fR \- create a preview
.SH "SYNOPSIS"
.nf
uffizzi preview create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
.fi
.SH "DESCRIPTION"
.nf
Creates a new preview\. If no COMPOSE_FILE is specified, the preview
is created with the project\'s default compose file\.

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://github\.com/UffizziCloud/uffizzi_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
    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 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
help for details\.
.fi
.SH "EXAMPLES"
.nf
To create a preview with the project\'s default compose file, run:

    $ uffizzi preview create

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

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
uffizzi-cli-1.0.5 man/uffizzi-preview-create
uffizzi-cli-1.0.4 man/uffizzi-preview-create
uffizzi-cli-1.0.3 man/uffizzi-preview-create
uffizzi-cli-1.0.2 man/uffizzi-preview-create
uffizzi-cli-1.0.1 man/uffizzi-preview-create
uffizzi-cli-1.0.0 man/uffizzi-preview-create
uffizzi-cli-0.14.0 man/uffizzi-preview-create