.\" 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

