The checkly deploy command deploys all your checks and associated resources like alert channels to your Checkly account. This command synchronizes your local monitoring-as-code configuration with your Checkly account.
Before using , ensure you have:
  • An initialized Checkly CLI project
  • At least one check or resource defined in your project
  • Valid Checkly account authentication (run npx checkly login if needed)
  • A checkly.config.ts or checkly.config.js configuration file
For additional setup information, see CLI overview.

​
Usage

The basic command deploys all resources to your Checkly account, synchronizing your local monitoring-as-code configuration with the Checkly monitoring infrastructure.
Terminal
npx checkly deploy [options]
OptionDescription
--config, -cThe Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.
--force, -fForce mode. Skips the confirmation dialog.
--output, -oShow the changes made after the deploy command.
--preview, -pShow a preview of the changes made by the deploy command.
--[no-]schedule-on-deployEnables automatic check scheduling after a deploy.
--[no-]verify-runtime-dependenciesReturn an error if checks import dependencies that are not supported by the selected runtime.

​
Command Options

​
--config, -c
string
Specify a configuration file to use instead of the checkly.config.ts or checkly.config.js in the current directory.Usage:
Terminal
npx checkly deploy --config="./checkly.staging.config.ts"
npx checkly deploy -c="./checkly.staging.config.ts"
​
--force, -f
boolean
Skip the interactive confirmation dialog and proceed with the operation.Use --force to set up automated CI/CD pipelines testing preview environments and deploying monitoring changes automatically.Usage:
Terminal
npx checkly deploy --force
npx checkly deploy -f
Examples
Terminal
$ npx checkly deploy --force

Parsing your project... ✅
Validating project resources... ✅
Bundling project resources... ✅

Successfully deployed project "Website Monitoring" to account "Monitoring as Code".
​
--output, -o
boolean
Show applied differences after deploying, providing a summary of what was changed.Usage:
Terminal
npx checkly deploy --output
npx checkly deploy -o
Examples:
Terminal
$ npx checkly deploy --output --force

Parsing your project... ✅
Validating project resources... ✅
Bundling project resources... ✅

Create:
  UrlMonitor:: homepage-uptime
  MultiStepCheck: auth-api-flow

Delete:
  Check: legacy-api-check

Update and Unchanged:
  SmsAlertChannel: sms-channel-1

Successfully deployed project "Website Monitoring" to account "Monitoring as Code".
​
--preview, -p
boolean
Show a preview of the changes that would be made by the deploy command.Usage:
Terminal
npx checkly deploy --preview
npx checkly deploy -p
Examples
Terminal
$ npx checkly deploy --preview

Parsing your project... ✅
Validating project resources... ✅
Bundling project resources... ✅

Create:
  UrlMonitor:: homepage-uptime
  MultiStepCheck: auth-api-flow

Delete:
  Check: legacy-api-check

Update and Unchanged:
  SmsAlertChannel: sms-channel-1
​
--[no-]schedule-on-deploy
boolean
default:"true"
Prevent checks from running automatically when they are deployed.Usage:
Terminal
npx checkly deploy --schedule-on-deploy
npx checkly deploy --no-schedule-on-deploy
Useful when you want to deploy changes but delay monitoring execution until later.
​
--[no-]verify-runtime-dependencies
boolean
default:"true"
Return an error if checks import dependencies that are not supported by the selected runtime.Usage:
Terminal
npx checkly deploy --verify-runtime-dependencies
npx checkly deploy --no-verify-runtime-dependencies
Runtime-dependent checks run in a specific runtime with a pre-defined set of dependencies. If you’re using private locations and want to provide your own dependencies, disable the built-in dependency validation.
You can provide custom dependencies in Playwright Check Suites because they don’t rely on a specific runtime.

​
Git Integration

When you deploy a project, you can attach Git-specific information so changes to any resources are displayed in the Checkly web UI with the correct commit, branch, and author information. The Checkly CLI evaluates Git information from your local or CI environment on a best effort basis. Override any automatically detected values by setting the corresponding environment variables.
itemautovariabledescription
RepositoryfalserepoUrl in checkly.config.ts or CHECKLY_REPO_URLThe URL of your repo on GitHub, GitLab etc.
Commit hashtrueCHECKLY_REPO_SHAThe SHA of the commit.
BranchtrueCHECKLY_REPO_BRANCHThe branch name.
Commit ownertrueCHECKLY_REPO_COMMIT_OWNERThe committer’s name or email.
Commit messagetrueCHECKLY_REPO_COMMIT_MESSAGEThe commit message.
EnvironmentfalseCHECKLY_TEST_ENVIRONMENTThe environment name, e.g. “staging”.