← All recipes
Moderne licensed

Install an orb

Recipe IDorg.openrewrite.circleci.InstallOrb
Artifactorg.openrewrite.recipe:rewrite-circleci

Install a CircleCI orb if it is not already installed.

Single recipeProprietary

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.circleci.InstallOrb --recipe-option "orbKey=kube" --recipe-option "slug=circleci/kubernetes@0.11.0"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-circleci:3.12.4

Options

NameTypeDescription
orbKeyrequiredStringThe orb key to be followed by an orb slug identifying a specific orb version.
e.g. kube
slugrequiredStringA specific orb to install, in the form <namespace>/<orb-name>@1.2.3.
e.g. circleci/kubernetes@0.11.0

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats