Start Building for Free
CircleCI.comAcademyBlogCommunitySupport

Orb development kit

3 months ago1 min read
Cloud
Server v4.x
Server v3.x
On This Page
  • Overview
  • Orb development kit components

Overview

Orbs are reusable snippets of code that help automate repeated processes, accelerate project setup, and make it easy to integrate with third-party tools. CircleCI maintains an orb registry with certified, partner, and third-party orbs.

The orb development kit refers to a suite of tools that work together to simplify the orb development process when authoring your own orb. The kit provides automatic testing and deployment on CircleCI.

The orb init command is the key to using the orb development kit. This command initiates a new orb project based on a template, and that template uses the other tools in the kit to automatically test and deploy your orb.

Orb development kit components

The orb development kit is made up of the following components:

  • Orb template: Repository with CircleCI’s orb project template, which is automatically ingested and modified by the orb init command.

  • CircleCI CLI: Contains two commands which are designed to work with the kit. The orb init command initializes a new orb project, and the orb pack command packs the orb source into a single orb.yml file.

  • Orb tools orb: An orb for creating orbs, which is automatically implemented as a part of the generated configuration when using the orb init command.

For more information on orb packing, see the Orbs concepts page.


Suggest an edit to this page

Make a contribution
Learn how to contribute