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

