Home

What Is The CircleCI Config SDK?

The CircleCI Config SDK is a JavaScript package library for generating CircleCI config YAML. Use the SDK to replace writing YAML in your projects, enhance CircleCI's Dynamic Configuration, or build integrations with CLI tools or browser-based experiences.

Get Started

• Install and setup
• Usage
• SDK API Docs
• Contributing

Installation

Using npm:

$ npm i @circleci/circleci-config-sdk

Using yarn:

$ yarn add @circleci/circleci-config-sdk

Usage

In Node.js:

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

In Browser:

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