Notploy

Patches

Versioned file overrides applied to an application at deploy time. Generated from the `notploy` command surface.

Versioned file overrides applied to an application at deploy time.

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

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

Commands

notploy patch by-entity-id

Calls GET /api/trpc/patch.byEntityId.

notploy patch by-entity-id --id <value> --type <value> [options]
OptionTypeRequiredAllowed values
--id <value>stringYes—
--type <value>stringYesapplication, compose
--profile <name>stringNo—

notploy patch clean-patch-repos

Calls POST /api/trpc/patch.cleanPatchRepos.

notploy patch clean-patch-repos [options]
OptionTypeRequiredAllowed values
--serverId <value>stringNo—
--profile <name>stringNo—

notploy patch create

Calls POST /api/trpc/patch.create.

notploy patch create --filePath <value> --content <value> [options]
OptionTypeRequiredAllowed values
--filePath <value>stringYes—
--content <value>stringYes—
--type <value>stringNocreate, update, delete
--enabled [boolean]booleanNo—
--no-enabledbooleanNo—
--applicationId <value>stringNo—
--composeId <value>stringNo—
--profile <name>stringNo—

notploy patch delete

Calls POST /api/trpc/patch.delete.

notploy patch delete --patchId <value> [options]
OptionTypeRequiredAllowed values
--patchId <value>stringYes—
--profile <name>stringNo—

notploy patch ensure-repo

Calls POST /api/trpc/patch.ensureRepo.

notploy patch ensure-repo --id <value> --type <value> [options]
OptionTypeRequiredAllowed values
--id <value>stringYes—
--type <value>stringYesapplication, compose
--profile <name>stringNo—

notploy patch mark-file-for-deletion

Calls POST /api/trpc/patch.markFileForDeletion.

notploy patch mark-file-for-deletion --id <value> --type <value> --filePath <value> [options]
OptionTypeRequiredAllowed values
--id <value>stringYes—
--type <value>stringYesapplication, compose
--filePath <value>stringYes—
--profile <name>stringNo—

notploy patch one

Calls GET /api/trpc/patch.one.

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

notploy patch read-repo-directories

Calls GET /api/trpc/patch.readRepoDirectories.

notploy patch read-repo-directories --id <value> --type <value> --repoPath <value> [options]
OptionTypeRequiredAllowed values
--id <value>stringYes—
--type <value>stringYesapplication, compose
--repoPath <value>stringYes—
--profile <name>stringNo—

notploy patch read-repo-file

Calls GET /api/trpc/patch.readRepoFile.

notploy patch read-repo-file --id <value> --type <value> --filePath <value> [options]
OptionTypeRequiredAllowed values
--id <value>stringYes—
--type <value>stringYesapplication, compose
--filePath <value>stringYes—
--profile <name>stringNo—

notploy patch save-file-as-patch

Calls POST /api/trpc/patch.saveFileAsPatch.

notploy patch save-file-as-patch --id <value> --type <value> --filePath <value> --content <value> [options]
OptionTypeRequiredAllowed values
--id <value>stringYes—
--type <value>stringYesapplication, compose
--filePath <value>stringYes—
--content <value>stringYes—
--patchType <value>stringNocreate, update
--profile <name>stringNo—

notploy patch toggle-enabled

Calls POST /api/trpc/patch.toggleEnabled.

notploy patch toggle-enabled --patchId <value> --enabled [options]
OptionTypeRequiredAllowed values
--patchId <value>stringYes—
--enabled [boolean]booleanYes—
--profile <name>stringNo—

notploy patch update

Calls POST /api/trpc/patch.update.

notploy patch update --patchId <value> [options]
OptionTypeRequiredAllowed values
--patchId <value>stringYes—
--type <value>stringNocreate, update, delete
--filePath <value>stringNo—
--enabled [boolean]booleanNo—
--no-enabledbooleanNo—
--content <value>stringNo—
--createdAt <value>stringNo—
--updatedAt <value>stringNo—
--profile <name>stringNo—

On this page