Notploy

Compose

Docker Compose projects: templates, imports, isolated deployments and previews. Generated from the `notploy` command surface.

Docker Compose projects: templates, imports, isolated deployments and previews.

notploy compose exposes 31 commands. They map one-to-one onto the compose.* API operations, so anything reachable from the dashboard is reachable from here.

Run notploy compose --help to list these commands in your terminal, or notploy compose <command> --help for a single command.

Commands

notploy compose cancel-deployment

Calls POST /api/trpc/compose.cancelDeployment.

notploy compose cancel-deployment --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose clean-queues

Calls POST /api/trpc/compose.cleanQueues.

notploy compose clean-queues --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose clear-deployments

Calls POST /api/trpc/compose.clearDeployments.

notploy compose clear-deployments --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose create

Calls POST /api/trpc/compose.create.

notploy compose create --name <value> --environmentId <value> [options]
OptionTypeRequiredAllowed values
--name <value>stringYes—
--description <value>stringNo—
--environmentId <value>stringYes—
--composeType <value>stringNodocker-compose, stack
--appName <value>stringNo—
--serverId <value>stringNo—
--composeFile <value>stringNo—
--sourceType <value>stringNogit, github, gitlab, bitbucket, gitea, raw
--profile <name>stringNo—

notploy compose delete

Calls POST /api/trpc/compose.delete.

notploy compose delete --composeId <value> --deleteVolumes [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--deleteVolumes [boolean]booleanYes—
--profile <name>stringNo—

notploy compose deploy

Calls POST /api/trpc/compose.deploy.

notploy compose deploy --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--title <value>stringNo—
--description <value>stringNo—
--freshVolumes [boolean]booleanNo—
--no-freshVolumesbooleanNo—
--profile <name>stringNo—

notploy compose deploy-template

Calls POST /api/trpc/compose.deployTemplate.

notploy compose deploy-template --environmentId <value> --id <value> [options]
OptionTypeRequiredAllowed values
--environmentId <value>stringYes—
--serverId <value>stringNo—
--id <value>stringYes—
--baseUrl <value>stringNo—
--profile <name>stringNo—

notploy compose disconnect-git-provider

Calls POST /api/trpc/compose.disconnectGitProvider.

notploy compose disconnect-git-provider --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose fetch-source-type

Calls POST /api/trpc/compose.fetchSourceType.

notploy compose fetch-source-type --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose get-converted-compose

Calls GET /api/trpc/compose.getConvertedCompose.

notploy compose get-converted-compose --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose get-default-command

Calls GET /api/trpc/compose.getDefaultCommand.

notploy compose get-default-command --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose get-tags

Calls GET /api/trpc/compose.getTags.

notploy compose get-tags [options]
OptionTypeRequiredAllowed values
--baseUrl <value>stringNo—
--profile <name>stringNo—

notploy compose import

Calls POST /api/trpc/compose.import.

notploy compose import --base64 <value> --composeId <value> [options]
OptionTypeRequiredAllowed values
--base64 <value>stringYes—
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose isolated-deployment

Calls POST /api/trpc/compose.isolatedDeployment.

notploy compose isolated-deployment --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--suffix <value>stringNo—
--profile <name>stringNo—

notploy compose kill-build

Calls POST /api/trpc/compose.killBuild.

notploy compose kill-build --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose load-mounts-by-service

Calls GET /api/trpc/compose.loadMountsByService.

notploy compose load-mounts-by-service --composeId <value> --serviceName <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--serviceName <value>stringYes—
--profile <name>stringNo—

notploy compose load-services

Calls GET /api/trpc/compose.loadServices.

notploy compose load-services --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--type <value>stringNofetch, cache
--profile <name>stringNo—

notploy compose move

Calls POST /api/trpc/compose.move.

notploy compose move --composeId <value> --targetEnvironmentId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--targetEnvironmentId <value>stringYes—
--profile <name>stringNo—

notploy compose one

Calls GET /api/trpc/compose.one.

notploy compose one --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose preview-template

Calls POST /api/trpc/compose.previewTemplate.

notploy compose preview-template --base64 <value> --appName <value> [options]
OptionTypeRequiredAllowed values
--base64 <value>stringYes—
--appName <value>stringYes—
--serverId <value>stringNo—
--profile <name>stringNo—

notploy compose process-template

Calls POST /api/trpc/compose.processTemplate.

notploy compose process-template --base64 <value> --composeId <value> [options]
OptionTypeRequiredAllowed values
--base64 <value>stringYes—
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose randomize-compose

Calls POST /api/trpc/compose.randomizeCompose.

notploy compose randomize-compose --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--suffix <value>stringNo—
--profile <name>stringNo—

notploy compose read-logs

Calls GET /api/trpc/compose.readLogs.

notploy compose read-logs --composeId <value> --containerId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--containerId <value>stringYes—
--tail <value>numberNo—
--since <value>stringNo—
--search <value>stringNo—
--profile <name>stringNo—

notploy compose redeploy

Calls POST /api/trpc/compose.redeploy.

notploy compose redeploy --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--title <value>stringNo—
--description <value>stringNo—
--freshVolumes [boolean]booleanNo—
--no-freshVolumesbooleanNo—
--profile <name>stringNo—

notploy compose refresh-token

Calls POST /api/trpc/compose.refreshToken.

notploy compose refresh-token --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose save-environment

Calls POST /api/trpc/compose.saveEnvironment.

notploy compose save-environment --composeId <value> --env <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--env <value>stringYes—
--createEnvFile [boolean]booleanNo—
--no-createEnvFilebooleanNo—
--profile <name>stringNo—

Calls GET /api/trpc/compose.search.

notploy compose search [options]
OptionTypeRequiredAllowed values
--q <value>stringNo—
--name <value>stringNo—
--appName <value>stringNo—
--description <value>stringNo—
--projectId <value>stringNo—
--environmentId <value>stringNo—
--limit <value>numberNo—
--offset <value>numberNo—
--profile <name>stringNo—

notploy compose start

Calls POST /api/trpc/compose.start.

notploy compose start --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose stop

Calls POST /api/trpc/compose.stop.

notploy compose stop --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy compose templates

Calls GET /api/trpc/compose.templates.

notploy compose templates [options]
OptionTypeRequiredAllowed values
--baseUrl <value>stringNo—
--profile <name>stringNo—

notploy compose update

Calls POST /api/trpc/compose.update.

notploy compose update --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--name <value>stringNo—
--appName <value>stringNo—
--description <value>stringNo—
--env <value>stringNo—
--composeFile <value>stringNo—
--refreshToken <value>stringNo—
--sourceType <value>stringNogit, github, gitlab, bitbucket, gitea, raw
--composeType <value>stringNodocker-compose, stack
--repository <value>stringNo—
--owner <value>stringNo—
--branch <value>stringNo—
--autoDeploy [boolean]booleanNo—
--no-autoDeploybooleanNo—
--gitlabProjectId <value>numberNo—
--gitlabRepository <value>stringNo—
--gitlabOwner <value>stringNo—
--gitlabBranch <value>stringNo—
--gitlabPathNamespace <value>stringNo—
--bitbucketRepository <value>stringNo—
--bitbucketRepositorySlug <value>stringNo—
--bitbucketOwner <value>stringNo—
--bitbucketBranch <value>stringNo—
--giteaRepository <value>stringNo—
--giteaOwner <value>stringNo—
--giteaBranch <value>stringNo—
--customGitUrl <value>stringNo—
--customGitBranch <value>stringNo—
--customGitSSHKeyId <value>stringNo—
--command <value>stringNo—
--createEnvFile [boolean]booleanNo—
--no-createEnvFilebooleanNo—
--enableSubmodules [boolean]booleanNo—
--no-enableSubmodulesbooleanNo—
--composePath <value>stringNo—
--suffix <value>stringNo—
--randomize [boolean]booleanNo—
--no-randomizebooleanNo—
--isolatedDeployment [boolean]booleanNo—
--no-isolatedDeploymentbooleanNo—
--isolatedDeploymentsVolume [boolean]booleanNo—
--no-isolatedDeploymentsVolumebooleanNo—
--pullImages [boolean]booleanNo—
--no-pullImagesbooleanNo—
--triggerType <value>stringNopush, tag
--composeStatus <value>stringNoidle, running, done, error
--icon <value>stringNo—
--environmentId <value>stringNo—
--createdAt <value>stringNo—
--watchPaths <json>arrayNo—
--githubId <value>stringNo—
--gitlabId <value>stringNo—
--bitbucketId <value>stringNo—
--giteaId <value>stringNo—
--serviceNetworks <json>arrayNo—
--profile <name>stringNo—

Applications

Create applications, connect a source, configure the build and drive the whole lifecycle. Generated from the `notploy` command surface.

Mounts

Bind mounts and named volumes attached to applications and Compose services. Generated from the `notploy` command surface.

On this page

Commandsnotploy compose cancel-deploymentnotploy compose clean-queuesnotploy compose clear-deploymentsnotploy compose createnotploy compose deletenotploy compose deploynotploy compose deploy-templatenotploy compose disconnect-git-providernotploy compose fetch-source-typenotploy compose get-converted-composenotploy compose get-default-commandnotploy compose get-tagsnotploy compose importnotploy compose isolated-deploymentnotploy compose kill-buildnotploy compose load-mounts-by-servicenotploy compose load-servicesnotploy compose movenotploy compose onenotploy compose preview-templatenotploy compose process-templatenotploy compose randomize-composenotploy compose read-logsnotploy compose redeploynotploy compose refresh-tokennotploy compose save-environmentnotploy compose searchnotploy compose startnotploy compose stopnotploy compose templatesnotploy compose update