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 crate_tag_prefix: 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: Option<String>,
    pub orb_context: Option<String>,
    pub gen_circleci_orb_version: String,
    pub mcp: bool,
    pub mcp_earliest_version: Option<String>,
    pub mcp_context: Vec<String>,
    pub git_push_subcommands: Vec<String>,
    pub home_url: Option<String>,
    pub source_url: Option<String>,
    pub record: bool,
    pub record_gpg_key_env: Option<String>,
    pub record_gpg_trust_env: Option<String>,
    pub record_user_name_env: Option<String>,
    pub record_user_email_env: Option<String>,
    pub record_signing_key_env: Option<String>,
    pub record_push_ssh_fingerprint: Option<String>,
    pub record_contexts: Vec<String>,
    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.

crate_tag_prefix: String

Tag prefix used by toolkit/release_crate for the crate (e.g. gen-orb-mcp-v). Used to filter the orb-release: workflow trigger in config.yml and to normalise CIRCLE_TAG for orb-tools/publish.

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: Option<String>

CircleCI context name holding Docker Hub credentials (DOCKER_LOGIN, DOCKER_PASSWORD). Prompted interactively if not supplied.

orb_context: Option<String>

CircleCI context name holding orb publishing credentials (CIRCLECI_CLI_TOKEN). Prompted interactively if not supplied.

gen_circleci_orb_version: String

Version of the jerus-org/gen-circleci-orb orb to pin in generated CI. Defaults to the version of this binary (orb and crate are released together).

mcp: bool

Wire in gen-orb-mcp MCP server generation + publish after orb publish.

mcp_earliest_version: Option<String>

Earliest orb version to include when priming prior-version snapshots. Passed to gen-circleci-orb/build_mcp_server as earliest_version. Only used when –mcp is enabled. Prompted interactively if not supplied.

mcp_context: Vec<String>

CircleCI context name(s) for MCP server build + publish + save steps (repeatable or comma-separated). Needs: GITHUB_TOKEN (GitHub App token, contents:write + bypass branch protection), BOT_GPG_KEY, BOT_TRUST, BOT_USER_NAME, BOT_USER_EMAIL, BOT_SIGN_KEY. Only used when –mcp is enabled. Prompted interactively if not supplied.

git_push_subcommands: Vec<String>

Subcommand names whose generated jobs should include a set_https_remote step (repeatable). Use for subcommands that push to git (e.g. save).

home_url: Option<String>

Home URL for the orb (shown in the CircleCI registry).

source_url: Option<String>

Source URL for the orb (shown in the CircleCI registry).

record: bool

Enable auto-record: after generate, the regenerate-orb CI job commits the regenerated orb source back (GPG-signed) and pushes it, so the published orb always reflects the CLI. When set, the --record-*-env flags name the environment variables that hold the GPG signing material at runtime (no defaults — they must be supplied). Prompted interactively if not set.

record_gpg_key_env: Option<String>

Name of the env var holding the base64-encoded GPG private key (auto-record).

record_gpg_trust_env: Option<String>

Name of the env var holding the GPG ownertrust export (auto-record).

record_user_name_env: Option<String>

Name of the env var holding the committer name (auto-record).

record_user_email_env: Option<String>

Name of the env var holding the committer email (auto-record).

record_signing_key_env: Option<String>

Name of the env var holding the GPG signing key id (auto-record).

record_push_ssh_fingerprint: Option<String>

SSH key fingerprint (a public-key hash, not a secret) for the end-of-workflow push job (auto-record). Optional: when set, the push job loads this write key and drops the read-only checkout key; empty falls back to ambient credentials. A value, not an env-var name — add_ssh_keys resolves fingerprints at config-compile time and cannot read env vars.

record_contexts: Vec<String>

CircleCI context(s) that supply the auto-record env-var values (GPG signing material), repeatable or comma-separated. The record CI job attaches these.

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.