preevy up
June 30, 2025 ยท View on GitHub
Bring up a preview environment
preevy up [SERVICE]
Bring up a preview environment
USAGE
$ preevy up [SERVICE...] (--access-credentials-type api|browser --include-access-credentials) [-D] [-f
<value>...] [--system-compose-file <value>...] [--project-directory <value>] [-p <value>] [--enable-plugin
<value>...] [--disable-plugin <value>...] [--profile <value>] [-d lightsail|gce|azure|kube-pod] [--lightsail-region
<value>] [--gce-project-id <value>] [--gce-zone <value>] [--azure-region <value>] [--azure-subscription-id <value>]
[--kube-pod-namespace <value>] [--kube-pod-kubeconfig <value>] [--kube-pod-context <value>]
[--lightsail-availability-zone <value>] [--lightsail-bundle-id
nano_2_0|micro_2_0|small_2_0|medium_2_0|large_2_0|xlarge_2_0|2xlarge_2_0] [--gce-machine-type <value>]
[--azure-vm-size <value>] [--kube-pod-template <value>] [--kube-pod-server-side-apply] [--kube-pod-storage-class
<value>] [--kube-pod-storage-size <value>] [--id <value>] [-t <value>] [--tls-hostname <value>]
[--insecure-skip-verify] [--no-build] [--no-registry-single-name | [--registry-single-name <value> --registry
<value>]] [--no-registry-cache ] [--builder <value>] [--no-cache] [--skip-volume <value>...]
[--skip-unchanged-files] [--show-preevy-service-urls] [--output-urls-to <value>] [--fetch-urls-timeout <value>]
[--wait] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml
| | ] [--sort <value>] [--github-token <value>] [--github-repo <value>] [--github-pull-request <value>]
[--github-pr-comment-template-file <value>] [--github-add-build-cache] [--github-pr-comment-enabled auto|no|always]
ARGUMENTS
SERVICE... Service name(s). If not specified, will deploy all services
FLAGS
-d, --driver=<option> Machine driver to use
<options: lightsail|gce|azure|kube-pod>
-t, --tunnel-url=<value> [default: ssh+tls://livecycle.run] Tunnel url, specify ssh://hostname[:port]
or ssh+tls://hostname[:port]
--access-credentials-type=<option> (required) [default: browser] Access credentials type
<options: api|browser>
--fetch-urls-timeout=<value> [default: 2500] Timeout for fetching URLs request in milliseconds
--id=<value> Environment id
--include-access-credentials Include access credentials for basic auth for each service URL
--insecure-skip-verify Skip TLS or SSH certificate verification
--output-urls-to=<value> Output URLs to file
--profile=<value> Run in a specific profile context (either an alias or a URL)
--project-directory=<value> Alternate working directory (default: the path of the first specified Compose
file)
--show-preevy-service-urls Show URLs for internal Preevy services
--[no-]skip-unchanged-files Detect and skip unchanged files when copying (default: true)
--skip-volume=<value>... [default: ] Additional volume glob patterns to skip copying (relative to
project directory)
--tls-hostname=<value> Override TLS server name when tunneling via HTTPS
--[no-]wait Wait for all tunnels to be ready
GLOBAL FLAGS
-D, --debug Enable debug logging
-f, --file=<value>... [default: ] Compose configuration file
-p, --project=<value> Project name. Defaults to the Compose project name
--disable-plugin=<value>... Disable plugin with specified package name
--enable-plugin=<value>... [default: @preevy/plugin-github] Enable plugin with specified package name
--system-compose-file=<value>... [default: ] Add extra Compose configuration file without overriding the defaults
OUTPUT FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
AZURE DRIVER FLAGS
--azure-region=<value> Microsoft Azure region in which resources will be provisioned
--azure-subscription-id=<value> Microsoft Azure Subscription ID
--azure-vm-size=<value> [default: Standard_B2s] Machine type to be provisioned
BUILD FLAGS
--builder=<value> Builder to use
--no-build Do not build images
--no-cache Do not use cache when building the images
--no-registry-cache Do not add the registry as a cache source and target
--no-registry-single-name Disable auto-detection for ECR-style registry single name
--registry=<value> Image registry. If this flag is specified, the "build-context" flag defaults to
"*local"
--registry-single-name=<value> Use single name for image registry, ECR-style. Default: auto-detect from "registry"
flag
GCE DRIVER FLAGS
--gce-machine-type=<value> Machine type to be provisioned
--gce-project-id=<value> Google Cloud project ID
--gce-zone=<value> Google Cloud zone in which resources will be provisioned
GITHUB INTEGRATION FLAGS
--github-add-build-cache Add github cache to the build
--github-pr-comment-enabled=<option> [default: auto] Whether to enable posting to the GitHub PR
<options: auto|no|always>
--github-pr-comment-template-file=<value> Path to nunjucks template file
--github-pull-request=<value> GitHub Pull Request number. Will auto-detect if not specified
--github-repo=<value> GitHub repo name in the format owner/repo. Will auto-detect if not
specified
--github-token=<value> GitHub token with write access to the repo
KUBE-POD DRIVER FLAGS
--kube-pod-context=<value> kubeconfig context name (will load config from defaults if not specified)
--kube-pod-kubeconfig=<value> Path to kubeconfig file (will load config from defaults if not specified)
--kube-pod-namespace=<value> [default: default] Kubernetes namespace in which resources will be provisioned
(needs to exist)
--[no-]kube-pod-server-side-apply Use server side apply to create Kubernetes resources
--kube-pod-storage-class=<value> Storage class to use for Pod data volume
--kube-pod-storage-size=<value> [default: 5] Size of Pod data volume in GiB
--kube-pod-template=<value> Path to custom resources template file (will use default template if not specified)
LIGHTSAIL DRIVER FLAGS
--lightsail-availability-zone=<value> AWS availability zone to provision resources in region
--lightsail-bundle-id=<option> Lightsail bundle ID (size of instance) to provision. Default: medium_2_0
<options:
nano_2_0|micro_2_0|small_2_0|medium_2_0|large_2_0|xlarge_2_0|2xlarge_2_0>
--lightsail-region=<value> AWS region in which resources will be provisioned
DESCRIPTION
Bring up a preview environment
FLAG DESCRIPTIONS
--id=<value> Environment id
Affects created URLs
If not specified, will detect from the current Git context
See code: src/commands/up.ts