Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

onboarder

package

v1.0.40468-pre Latest Latest Go to latest Published: Jun 16, 2026 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/CircleCI-Public/circleci-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package onboarder orchestrates the local onboarding flow.

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Run ¶

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

Run scans a repository, verifies its tests, generates a starter config when needed, and ensures the CLI has an authenticated CircleCI session.

Types ¶

type Options ¶

type Options struct {
	ConfigPath    string
	NoBrowser     bool
	SecureStorage bool
}

Options configures the onboarding flow.

Source Files ¶

View all Source files

onboarder.go