Usage

CircleCI Config SDK Usage

Use SDK in your CircleCI Pipeline

The most typical usage of the CircleCI Config SDK will be for replacing or augmenting the YAML configuration file needed to run pipelines on CircleCI.com with a JavaScript or TypeScript app.

See how to use the CircleCI SDK in your project.

Build integrations using the SDK

While the CircleCI Config SDK can be used directly, it can also be used as a tool for generating a static CircleCI Config YAML. This is useful for CLI tools that wish to produce a CircleCI config, or browser-based tooling, such as a visual config editor.

See building integrations.

Extend Config SDK with packages

Similar to the concept of "Orbs" on CircleCI, components created with the CircleCI SDK can be packaged and distributed as Node packages.

See how to create and publish a package for the CircleCI Config SDK.