Deployments

Inspect deployment history and queues, read deployment logs and kill a running build. Generated from the `notploy` command surface.

Inspect deployment history and queues, read deployment logs and kill a running build.

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

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

Commands

`notploy deployment all`

Calls GET /api/trpc/deployment.all.

notploy deployment all --applicationId <value> [options]

Option	Type	Required	Allowed values
`--applicationId <value>`	string	Yes	—
`--profile <name>`	string	No	—

`notploy deployment all-by-compose`

Calls GET /api/trpc/deployment.allByCompose.

notploy deployment all-by-compose --composeId <value> [options]

Option	Type	Required	Allowed values
`--composeId <value>`	string	Yes	—
`--profile <name>`	string	No	—

`notploy deployment all-by-server`

Calls GET /api/trpc/deployment.allByServer.

notploy deployment all-by-server --serverId <value> [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	Yes	—
`--profile <name>`	string	No	—

`notploy deployment all-by-type`

Calls GET /api/trpc/deployment.allByType.

notploy deployment all-by-type --id <value> --type <value> [options]

Option	Type	Required	Allowed values
`--id <value>`	string	Yes	—
`--type <value>`	string	Yes	`application`, `compose`, `server`, `schedule`, `previewDeployment`, `backup`, `volumeBackup`
`--profile <name>`	string	No	—

`notploy deployment all-centralized`

Calls GET /api/trpc/deployment.allCentralized.

notploy deployment all-centralized [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy deployment centralized-page`

Calls GET /api/trpc/deployment.centralizedPage.

notploy deployment centralized-page [options]

Option	Type	Required	Allowed values
`--offset <value>`	number	No	—
`--limit <value>`	number	No	—
`--status <value>`	string	No	`running`, `done`, `error`, `cancelled`
`--type <value>`	string	No	`application`, `compose`
`--search <value>`	string	No	—
`--sortOrder <value>`	string	No	`newest`, `oldest`
`--profile <name>`	string	No	—

`notploy deployment home-activity`

Calls GET /api/trpc/deployment.homeActivity.

notploy deployment home-activity [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy deployment kill-process`

Calls POST /api/trpc/deployment.killProcess.

notploy deployment kill-process --deploymentId <value> [options]

Option	Type	Required	Allowed values
`--deploymentId <value>`	string	Yes	—
`--profile <name>`	string	No	—

`notploy deployment queue-list`

Calls GET /api/trpc/deployment.queueList.

notploy deployment queue-list [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy deployment read-logs`

Calls GET /api/trpc/deployment.readLogs.

notploy deployment read-logs --deploymentId <value> [options]

Option	Type	Required	Allowed values
`--deploymentId <value>`	string	Yes	—
`--tail <value>`	number	No	—
`--profile <name>`	string	No	—

`notploy deployment remove-deployment`

Calls POST /api/trpc/deployment.removeDeployment.

notploy deployment remove-deployment --deploymentId <value> [options]

Option	Type	Required	Allowed values
`--deploymentId <value>`	string	Yes	—
`--profile <name>`	string	No	—

On this page