cli

package module
v2.0.0 Latest Latest
Warning

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

 Go to latest Published: Jul 26, 2022 License: MIT Imports: 30 Imported by: 0

README

bk - The Buildkite CLI

Latest release

A command line interface for Buildkite.

💬 Feedback

We'd love to hear any feedback and questions you might have. Please file an issue on GitHub and let us know 💖

⬇️ Installation

On macOS, you can install with Homebrew:

brew install buildkite/cli/bk

On all other platforms, download a binary from the latest GitHub releases.

📄 Usage

# Sets up your credentials (stored in `$HOME/.buildkite/config.json` or `$BUILDKITE_CLI_CONFIG_FILE`)
bk configure

# Opens the current pipeline in your browser
bk browse

# List the pipelines that you have access to
bk pipeline list

# Triggers a build for the current directory's commit and branch
bk build create

# Runs the current directory's pipeline steps locally (requires the buildkite-agent to be installed)
bk local run

# Sets up your current git project directory for Buildkite, creating a .buildkite/pipeline.yml file, a pipeline in Buildkite, and setting up the webhooks on GitHub or Bitbucket
bk init

🔨 Development

Developed using Golang 1.11+ with modules.

export GO111MODULE=on
git clone git@github.com:buildkite/cli.git
cd cli/
go run ./cmd/bk --help

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Debug bool
)
View Source 
var (
	// Version is the version of the CLI tool
	Version = "2.0.0"
)

Functions

func ArtifactDownloadCommand 

func ArtifactDownloadCommand(ctx ArtifactDownloadCommandContext) error

func BrowseCommand 

func BrowseCommand(ctx BrowseCommandContext) error

func BuildCreateCommand 

func BuildCreateCommand(ctx BuildCreateCommandContext) error

func ConfigureBuildkiteGraphQLCommand 

func ConfigureBuildkiteGraphQLCommand(ctx ConfigureCommandContext) error

func ConfigureDefaultCommand 

func ConfigureDefaultCommand(ctx ConfigureCommandContext) error

func ConfigureGithubCommand 

func ConfigureGithubCommand(ctx ConfigureCommandContext) error

func InitCommand 

func InitCommand(ctx InitCommandContext) error

func LocalRunCommand 

func LocalRunCommand(ctx LocalRunCommandContext) error

func PipelineListCommand 

func PipelineListCommand(ctx PipelineListCommandContext) error

func VersionString 

func VersionString() string

Types

type ArtifactDownloadCommandContext 

type ArtifactDownloadCommandContext struct {
	TerminalContext
	ConfigContext

	Debug     bool
	DebugHTTP bool

	Build   string
	Job     string
	Pattern string
}

type BrowseCommandContext 

type BrowseCommandContext struct {
	TerminalContext
	ConfigContext

	Debug     bool
	DebugHTTP bool

	Dir    string
	Branch string
}

type BuildCreateCommandContext 

type BuildCreateCommandContext struct {
	TerminalContext
	ConfigContext

	Debug     bool
	DebugHTTP bool

	Dir          string
	PipelineSlug string

	Branch   string
	Commit   string
	Message  string
	Env      []string
	Metadata map[string]string
}

type ConfigContext 

type ConfigContext struct {
}

func (ConfigContext) BuildkiteGraphQLClient 

func (cc ConfigContext) BuildkiteGraphQLClient() (*graphql.Client, error)

func (ConfigContext) GithubClient 

func (cc ConfigContext) GithubClient() (*githubclient.Client, error)

type ConfigureCommandContext 

type ConfigureCommandContext struct {
	TerminalContext
	ConfigContext

	Debug        bool
	DebugGraphQL bool
}

type ExitCoder 

type ExitCoder interface {
	ExitCode() int
}

type ExitError 

type ExitError struct {
	// contains filtered or unexported fields
}

func NewExitError 

func NewExitError(err error, exitCode int) ExitError

func NewExitErrorString 

func NewExitErrorString(msg string, exitCode int) ExitError

func (ExitError) Error 

func (ex ExitError) Error() string

func (ExitError) ExitCode 

func (ex ExitError) ExitCode() int

type InitCommandContext 

type InitCommandContext struct {
	TerminalContext
	ConfigContext

	Debug     bool
	DebugHTTP bool

	Dir          string
	PipelineSlug string
}

type LocalRunCommandContext 

type LocalRunCommandContext struct {
	TerminalContext
	ConfigContext

	Debug     bool
	DebugHTTP bool

	File            *os.File
	Env             []string
	Metadata        map[string]string
	Command         string
	StepFilterRegex *regexp.Regexp
	Prompt          bool
	DryRun          bool
	ListenPort      int
}

type PipelineListCommandContext 

type PipelineListCommandContext struct {
	TerminalContext
	ConfigContext

	Debug     bool
	DebugHTTP bool

	Fuzzy   string
	Limit   int
	ShowURL bool
}

type Spinner 

type Spinner interface {
	Start()
	Stop()
}

type Terminal 

type Terminal struct {
}

func (*Terminal) Failure 

func (t *Terminal) Failure(msg string)

func (*Terminal) Header 

func (t *Terminal) Header(h string)

func (*Terminal) Printf 

func (t *Terminal) Printf(s string, v ...interface{})

func (*Terminal) Println 

func (t *Terminal) Println(s ...interface{})

func (*Terminal) ReadPassword 

func (t *Terminal) ReadPassword(prompt string) (string, error)

func (*Terminal) ReadString 

func (t *Terminal) ReadString(prompt string) (string, error)

func (*Terminal) Spinner 

func (t *Terminal) Spinner() Spinner

func (*Terminal) Try 

func (t *Terminal) Try() Tryer

func (*Terminal) WaitForKeyPress 

func (t *Terminal) WaitForKeyPress(prompt string)

type TerminalContext 

type TerminalContext interface {
	Header(h string)
	Println(s ...interface{})
	Printf(s string, v ...interface{})
	Failure(s string)
	WaitForKeyPress(prompt string)
	Spinner() Spinner
	Try() Tryer
	ReadPassword(prompt string) (string, error)
}

type Tryer 

type Tryer interface {
	Start(msg string)
	Println(msg string)
	Success(msg string)
	Failure(msg string)
}

Source Files

View all Source files

Directories

Path Synopsis
cmd
bk

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.