onboarder

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 6, 2026 License: MIT Imports: 22 Imported by: 0

Documentation

Overview

Package onboarder orchestrates the local onboarding flow.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Run

func Run(ctx context.Context, dir string, opts Options) error

Run generates a starter config for a repository when it has none, and ensures the CLI has an authenticated CircleCI session.

Types

type Options

type Options struct {
	ConfigPath    string
	NoBrowser     bool
	SecureStorage bool
	Scan          bool
	Signup        bool
	// Org is the organization to set the project up in, as a slug (gh/acme) or a
	// UUID. When empty the organization is auto-selected if the account has
	// exactly one, and prompted for otherwise; a session that cannot be prompted
	// is an error rather than a silent no-op, because there is nothing onboard
	// can do without one. See selectOrg.
	Org string
	// RepoID is the provider's repository ID used to wire up the first pipeline
	// definition and trigger. When empty it is resolved through the integration
	// that owns the checkout's remote; if that cannot resolve it, pipeline setup is
	// skipped with manual guidance. It is never prompted for — an opaque ID is not
	// something a user can be expected to know.
	RepoID string
}

Options configures the onboarding flow.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL