CircleCI config SDK

Cloud

Overview

The CircleCI Config SDK is a JavaScript package library (also compatible with TypeScript) for generating a CircleCI YAML configuration file. Use the SDK to:

Replace writing YAML configuration files
Generate a static YAML configuration file
Modularize and manage your configuration as JavaScript packages
Enhance CircleCI’s dynamic configuration
Build integrations with CLI tools or browser-based experiences

For example, generating a static configuration file can be useful for CLI tools where you want to create a CircleCI configuration, or browser-based tooling, such as a visual config editor.

Components created with the CircleCI Config SDK can be packaged and distributed as Node packages.

Install the SDK

Install the CircleCI Config SDK with NPM or Yarn, and include it in your project via Node.js or the browser.

NPM installation:

$ npm i @circleci/circleci-config-sdk

Yarn installation:

yarn add @circleci/circleci-config-sdk

Use in Node.js

import CircleCI from '@circleci/circleci-config-sdk';

Use in the browser:

const CircleCI = require('@circleci/circleci-config-sdk');

Visit the SDK page to view a full example of generating a CircleCI configuration.

Contribute

The CircleCI Config SDK is open source, and contributions are welcome. Visit the contributing guide to view the guidelines and release process.

Help make this document better

This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.

Suggest an edit to this page (please read the contributing guide first).
To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.

Need support?

Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.

You can also visit our support site to find support articles, community forums, and training resources.

CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.