Docs

Commits

Commands for managing commits in the Knock CLI.

Commit commands enable you to manage commits in your Knock account from the CLI.

knock commit list [flags]

List all commits in the environment. Use an --environment flag to specify the target environment; if omitted, the Knock CLI defaults to the development environment.

Flags

--environmentstring

The environment to use. Defaults to development.

--[no-]promotedboolean

Show only promoted or unpromoted changes between the given environment and the subsequent environment.

--limitnumber

The total number to fetch per page.

--afterstring

Fetches all entries after this cursor.

--beforestring

Fetches all entries before this cursor.

--branchstring

The branch to use. Defaults to the main branch.

--resource-typestring

Filter commits by resource type. One of: email_layout, guide, message_type, partial, translation, workflow. Can be used alone or together with --resource-id.

--resource-idstring

Filter commits by the given resource identifier. This is most typically the key of the resource. In the case of translations, this will be the locale code and namespace, separated by a /. Must be used together with --resource-type.

--jsonstring

Format output as json.

knock commit get <commit_id> [flags]

Shows the details of a given commit, using the id of the commit.

Flags

--jsonstring

Format output as json.

knock commit [flags]

You can commit all changes across all resources in the development environment with the commit command. Use --resource-type to commit only changes for a specific resource type, and optionally --resource-id to scope it further to a single resource.

Flags

-m, --commit-messagestring

The commit message to use for all changes.

--branchstring

The branch to use. Defaults to the main branch.

--forceboolean

Removes the confirmation prompt. Defaults to false.

--resource-typestring

Commit only changes for the given resource type. One of: email_layout, guide, message_type, partial, translation, workflow. Can be used alone or together with --resource-id.

--resource-idstring

Commit only changes for the given resource identifier. Must be used together with --resource-type.

knock commit promote [flags]

You can promote one change to the subsequent environment, or all changes across all resources to the target environment from its directly preceding environment, using the commit promote command.

Note:

For example, if you have three environments "development", "staging", and "production" (in that order), setting the --to flag to production will promote all new changes from the staging environment to the production environment.
Promoting one single commit from staging using the --only flag, will result in that commit being promoted to production.
The --to environment must be a non-development environment.
The --to and --only flags can't be used together.

Flags

--tostring

The destination environment.

--onlystring

The target commit id to promote to the subsequent environment.

--forceboolean

Removes the confirmation prompt. Defaults to false.