Orb development kit
On This Page
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.
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
CircleCI CLI: Contains two commands which are designed to work with the kit. The
orb initcommand initializes a new orb project, and the
orb packcommand packs the orb source into a single
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.
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 guidefirst).
- 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.
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.