Struct Init 

pub struct Init {

    pub binary: String,
    pub public_orb_namespaces: Vec<String>,
    pub private_orb_namespaces: Vec<String>,
    pub build_workflow: String,
    pub release_workflow: String,
    pub requires_job: Option<String>,
    pub release_after_job: String,
    pub orb_dir: String,
    pub ci_dir: PathBuf,
    pub orb_tools_version: String,
    pub docker_orb_version: String,
    pub docker_namespace: String,
    pub docker_context: String,
    pub orb_context: String,
    pub mcp: bool,
    pub dry_run: bool,
}

Wire orb generation into an existing repo’s CI configuration.

Fields

binary: String

Name of the binary to introspect (must be on PATH).

public_orb_namespaces: Vec<String>

CircleCI namespace(s) to publish the orb under as a public orb (repeatable). Must be set correctly on first init — visibility cannot be changed after the orb is created.

private_orb_namespaces: Vec<String>

CircleCI namespace(s) to publish the orb under as a private orb (repeatable). Each listed namespace gets --private in its circleci orb create command. Must be set correctly on first init — visibility cannot be changed after the orb is created.

build_workflow: String

Name of the build/validation workflow to patch.

release_workflow: String

Name of the release workflow to patch.

requires_job: Option<String>

Job in the build workflow that regenerate-orb should require.

release_after_job: String

Job in the release workflow after which the generated release jobs (build-binary-release, pack-orb-release, build-container, ensure-orb-registered) should be gated. This is the sole mechanism for specifying where the generated jobs plug into the existing pipeline topology.

orb_dir: String

Output directory for the generated orb source (relative to repo root).

ci_dir: PathBuf

Path to the .circleci/ directory.

orb_tools_version: String

circleci/orb-tools version to pin in generated CI.

docker_orb_version: String

circleci/docker orb version to pin in generated CI.

docker_namespace: String

Docker Hub (or registry) namespace for the built container image.

docker_context: String

CircleCI context name holding Docker Hub credentials.

orb_context: String

CircleCI context name holding orb publishing credentials.

mcp: bool

Wire in toolkit/build_mcp_server after orb publish (requires jerus-org/circleci-toolkit).

dry_run: bool

Show planned changes without modifying any files.

Implementations

impl Init

pub fn run(&self) -> Result<()>

Trait Implementations

impl Args for Init

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for Init

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Init

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.