Notploy

Environments

Applications and databases live inside an environment, and environments belong to a project. Generated from the `notploy` command surface.

Applications and databases live inside an environment, and environments belong to a project.

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

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

Commands

notploy environment by-project-id

Calls GET /api/trpc/environment.byProjectId.

notploy environment by-project-id --projectId <value> [options]
OptionTypeRequiredAllowed values
--projectId <value>stringYes—
--profile <name>stringNo—

notploy environment create

Calls POST /api/trpc/environment.create.

notploy environment create --name <value> --projectId <value> [options]
OptionTypeRequiredAllowed values
--name <value>stringYes—
--description <value>stringNo—
--projectId <value>stringYes—
--profile <name>stringNo—

notploy environment duplicate

Calls POST /api/trpc/environment.duplicate.

notploy environment duplicate --environmentId <value> --name <value> [options]
OptionTypeRequiredAllowed values
--environmentId <value>stringYes—
--name <value>stringYes—
--description <value>stringNo—
--profile <name>stringNo—

notploy environment one

Calls GET /api/trpc/environment.one.

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

notploy environment remove

Calls POST /api/trpc/environment.remove.

notploy environment remove --environmentId <value> [options]
OptionTypeRequiredAllowed values
--environmentId <value>stringYes—
--profile <name>stringNo—

Calls GET /api/trpc/environment.search.

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

notploy environment update

Calls POST /api/trpc/environment.update.

notploy environment update --environmentId <value> [options]
OptionTypeRequiredAllowed values
--environmentId <value>stringYes—
--name <value>stringNo—
--description <value>stringNo—
--projectId <value>stringNo—
--env <value>stringNo—
--profile <name>stringNo—

On this page