Skip to content

checkly-deploy.mdx

Latest commit

 

History

History
184 lines (120 loc) · 5.45 KB

checkly-deploy.mdx

File metadata and controls

184 lines (120 loc) · 5.45 KB
title checkly deploy
description Deploy checks and resources to your Checkly account.
sidebarTitle checkly deploy

import CliCommandPrerequisites from '/snippets/cli-command-prerequisites.mdx'; import CliEnvVars from "/snippets/cli-env-vars.mdx"

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.

Usage

The basic command deploys all resources to your Checkly account, synchronizing your local monitoring-as-code configuration with the Checkly monitoring infrastructure.

npx checkly deploy [options]
Option Description
--config, -c The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.
--force, -f Force mode. Skips the confirmation dialog.
--debug-bundle Generate a JSON file containing the data sent to our servers when you deploy. Note: This flag is in beta. The bundle’s structure is not considered a stable format and may change without notice. It’s intended for one-off troubleshooting, and note it may contain secrets before sharing.
--output, -o Show the changes made after the deploy command.
--preview, -p Show a preview of the changes made by the deploy command.
--[no-]schedule-on-deploy Enables automatic check scheduling after a deploy.
--[no-]verify-runtime-dependencies Return an error if checks import dependencies that are not supported by the selected runtime.

Command Options

Specify a configuration file to use instead of the checkly.config.ts or checkly.config.js in the current directory.

Usage:

npx checkly deploy --config="./checkly.staging.config.ts"
npx checkly deploy -c="./checkly.staging.config.ts"

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:

npx checkly deploy --force
npx checkly deploy -f

Examples

$ npx checkly deploy --force

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

Successfully deployed project "Website Monitoring" to account "Monitoring as Code".

Show applied differences after deploying, providing a summary of what was changed.

Usage:

npx checkly deploy --output
npx checkly deploy -o

Examples:

$ 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".

Show a preview of the changes that would be made by the deploy command.

Usage:

npx checkly deploy --preview
npx checkly deploy -p

Examples

$ 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

Prevent checks from running automatically when they are deployed.

Usage:

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.

Return an error if checks import dependencies that are not supported by the selected runtime.

Usage:

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.

Related Commands