cli

package
v0.0.0-...-29341db Latest Latest
Warning

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

 Go to latest Published: Jul 29, 2026 License: Apache-2.0 Imports: 40 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// RESOURCE_URL_PATTERN is used to check if the resrouce URL starts with http:// or https://
	RESOURCE_URL_PATTERN = `.+:\/{2}.+`
)

Variables

View Source 
var (
	Starter      = start.New()
	WaitDuration = 5 * time.Second
)
View Source 
var IsTerminalFn = func(c *stdcli.Context) bool {
	return c.Writer().IsTerminal()
}

IsTerminalFn reports whether the context's writer is attached to a real terminal, used to gate masking of sensitive output in `convox rack params`. This is a VAR, not a function, so that tests can override it.

Not to be confused with stdcli.IsTerminal(*os.File) — that is the underlying syscall helper from the vendored stdcli package. IsTerminalFn wraps the stdcli call at the *stdcli.Context layer so test code can swap the behavior without producing a real PTY.

Not public API. Exported only because test files use `package cli_test` (black-box), which cannot reach unexported symbols. External consumers of pkg/cli must not take a dependency on this var — it may be renamed or removed without a deprecation cycle.

Callers: pkg/cli/rack.go (RackParams).

CONCURRENCY: this var is mutable package state. Tests that override it MUST restore via t.Cleanup AND MUST NOT call t.Parallel anywhere in pkg/cli that executes concurrently with an override — the race will surface under `go test -race`. At patch time no test in pkg/cli calls t.Parallel (verified).

Functions

func Api 

func Api(rack sdk.Interface, c *stdcli.Context) error

func Apps 

func Apps(rack sdk.Interface, c *stdcli.Context) error

func AppsCancel 

func AppsCancel(rack sdk.Interface, c *stdcli.Context) error

func AppsCreate 

func AppsCreate(rack sdk.Interface, c *stdcli.Context) error

func AppsDelete 

func AppsDelete(rack sdk.Interface, c *stdcli.Context) error

func AppsExport 

func AppsExport(rack sdk.Interface, c *stdcli.Context) error

func AppsImport 

func AppsImport(rack sdk.Interface, c *stdcli.Context) error

func AppsInfo 

func AppsInfo(rack sdk.Interface, c *stdcli.Context) error

func AppsLock 

func AppsLock(rack sdk.Interface, c *stdcli.Context) error

func AppsParams 

func AppsParams(rack sdk.Interface, c *stdcli.Context) error

func AppsParamsSet 

func AppsParamsSet(rack sdk.Interface, c *stdcli.Context) error

func AppsUnlock 

func AppsUnlock(rack sdk.Interface, c *stdcli.Context) error

func AppsWait 

func AppsWait(rack sdk.Interface, c *stdcli.Context) error

func Build 

func Build(rack sdk.Interface, c *stdcli.Context) error

func Builds 

func Builds(rack sdk.Interface, c *stdcli.Context) error

func BuildsExport 

func BuildsExport(rack sdk.Interface, c *stdcli.Context) error

func BuildsImport 

func BuildsImport(rack sdk.Interface, c *stdcli.Context) error

func BuildsInfo 

func BuildsInfo(rack sdk.Interface, c *stdcli.Context) error

func BuildsLogs 

func BuildsLogs(rack sdk.Interface, c *stdcli.Context) error

func Certs 

func Certs(rack sdk.Interface, c *stdcli.Context) error

func CertsDelete 

func CertsDelete(rack sdk.Interface, c *stdcli.Context) error

func CertsGenerate 

func CertsGenerate(rack sdk.Interface, c *stdcli.Context) error

func CertsImport 

func CertsImport(rack sdk.Interface, c *stdcli.Context) error

func Cp 

func Cp(rack sdk.Interface, c *stdcli.Context) error

func Decrypt 

func Decrypt(_ sdk.Interface, c *stdcli.Context) error

func Deploy 

func Deploy(rack sdk.Interface, c *stdcli.Context) error

func Encrypt 

func Encrypt(_ sdk.Interface, c *stdcli.Context) error

func Env 

func Env(rack sdk.Interface, c *stdcli.Context) error

func EnvEdit 

func EnvEdit(rack sdk.Interface, c *stdcli.Context) error

func EnvGet 

func EnvGet(rack sdk.Interface, c *stdcli.Context) error

func EnvSet 

func EnvSet(rack sdk.Interface, c *stdcli.Context) error

func EnvUnset 

func EnvUnset(rack sdk.Interface, c *stdcli.Context) error

func Exec 

func Exec(rack sdk.Interface, c *stdcli.Context) error

func Instances 

func Instances(rack sdk.Interface, c *stdcli.Context) error

func InstancesKeyroll 

func InstancesKeyroll(rack sdk.Interface, c *stdcli.Context) error

func InstancesSsh 

func InstancesSsh(rack sdk.Interface, c *stdcli.Context) error

func InstancesTerminate 

func InstancesTerminate(rack sdk.Interface, c *stdcli.Context) error

func Login 

func Login(rack sdk.Interface, c *stdcli.Context) error

func Logs 

func Logs(rack sdk.Interface, c *stdcli.Context) error

func Proxy 

func Proxy(rack sdk.Interface, c *stdcli.Context) error

func Ps 

func Ps(rack sdk.Interface, c *stdcli.Context) error

func PsInfo 

func PsInfo(rack sdk.Interface, c *stdcli.Context) error

func PsStop 

func PsStop(rack sdk.Interface, c *stdcli.Context) error

func Rack 

func Rack(rack sdk.Interface, c *stdcli.Context) error

func RackAccess 

func RackAccess(rack sdk.Interface, c *stdcli.Context) error

func RackAccessKeyRotate 

func RackAccessKeyRotate(rack sdk.Interface, c *stdcli.Context) error

func RackInstall 

func RackInstall(rack sdk.Interface, c *stdcli.Context) error

func RackLogs 

func RackLogs(rack sdk.Interface, c *stdcli.Context) error

func RackParams 

func RackParams(rack sdk.Interface, c *stdcli.Context) error

func RackParamsSet 

func RackParamsSet(rack sdk.Interface, c *stdcli.Context) error

func RackPs 

func RackPs(rack sdk.Interface, c *stdcli.Context) error

func RackReleases 

func RackReleases(rack sdk.Interface, c *stdcli.Context) error

func RackResources 

func RackResources(rack sdk.Interface, c *stdcli.Context) error

func RackResourcesCreate 

func RackResourcesCreate(rack sdk.Interface, c *stdcli.Context) error

func RackResourcesDelete 

func RackResourcesDelete(rack sdk.Interface, c *stdcli.Context) error

func RackResourcesInfo 

func RackResourcesInfo(rack sdk.Interface, c *stdcli.Context) error
func RackResourcesLink(rack sdk.Interface, c *stdcli.Context) error

func RackResourcesOptions 

func RackResourcesOptions(rack sdk.Interface, c *stdcli.Context) error

func RackResourcesProxy 

func RackResourcesProxy(rack sdk.Interface, c *stdcli.Context) error

func RackResourcesTypes 

func RackResourcesTypes(rack sdk.Interface, c *stdcli.Context) error
func RackResourcesUnlink(rack sdk.Interface, c *stdcli.Context) error

func RackResourcesUpdate 

func RackResourcesUpdate(rack sdk.Interface, c *stdcli.Context) error

func RackResourcesUrl 

func RackResourcesUrl(rack sdk.Interface, c *stdcli.Context) error

func RackRuntimeAttach 

func RackRuntimeAttach(rack sdk.Interface, c *stdcli.Context) error

func RackRuntimes 

func RackRuntimes(rack sdk.Interface, c *stdcli.Context) error

func RackScale 

func RackScale(rack sdk.Interface, c *stdcli.Context) error

func RackSync 

func RackSync(rack sdk.Interface, c *stdcli.Context) error

func RackSyncWhiteListInstancesIp 

func RackSyncWhiteListInstancesIp(rack sdk.Interface, c *stdcli.Context) error

func RackUninstall 

func RackUninstall(rack sdk.Interface, c *stdcli.Context) error

func RackUpdate 

func RackUpdate(rack sdk.Interface, c *stdcli.Context) error

func RackWait 

func RackWait(rack sdk.Interface, c *stdcli.Context) error

func Racks 

func Racks(rack sdk.Interface, c *stdcli.Context) error

func Registries 

func Registries(rack sdk.Interface, c *stdcli.Context) error

func RegistriesAdd 

func RegistriesAdd(rack sdk.Interface, c *stdcli.Context) error

func RegistriesRemove 

func RegistriesRemove(rack sdk.Interface, c *stdcli.Context) error

func Releases 

func Releases(rack sdk.Interface, c *stdcli.Context) error

func ReleasesInfo 

func ReleasesInfo(rack sdk.Interface, c *stdcli.Context) error

func ReleasesManifest 

func ReleasesManifest(rack sdk.Interface, c *stdcli.Context) error

func ReleasesPromote 

func ReleasesPromote(rack sdk.Interface, c *stdcli.Context) error

func ReleasesRollback 

func ReleasesRollback(rack sdk.Interface, c *stdcli.Context) error

func Resources 

func Resources(rack sdk.Interface, c *stdcli.Context) error

func ResourcesDeleteDB 

func ResourcesDeleteDB(rack sdk.Interface, c *stdcli.Context) error

func ResourcesFixCf 

func ResourcesFixCf(rack sdk.Interface, c *stdcli.Context) error

func ResourcesInfo 

func ResourcesInfo(rack sdk.Interface, c *stdcli.Context) error

func ResourcesProxy 

func ResourcesProxy(rack sdk.Interface, c *stdcli.Context) error

func ResourcesUrl 

func ResourcesUrl(rack sdk.Interface, c *stdcli.Context) error

func Restart 

func Restart(rack sdk.Interface, c *stdcli.Context) error

func Run 

func Run(rack sdk.Interface, c *stdcli.Context) error

func Scale 

func Scale(rack sdk.Interface, c *stdcli.Context) error

func Services 

func Services(rack sdk.Interface, c *stdcli.Context) error

func ServicesRestart 

func ServicesRestart(rack sdk.Interface, c *stdcli.Context) error

func Ssl 

func Ssl(rack sdk.Interface, c *stdcli.Context) error

func SslUpdate 

func SslUpdate(rack sdk.Interface, c *stdcli.Context) error

func Start 

func Start(rack sdk.Interface, c *stdcli.Context) error

func Switch 

func Switch(rack sdk.Interface, c *stdcli.Context) error

func Test 

func Test(rack sdk.Interface, c *stdcli.Context) error

func Update 

func Update(rack sdk.Interface, c *stdcli.Context) error

func Version 

func Version(rack sdk.Interface, c *stdcli.Context) error

Types

type AuthenticationError 

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

func (AuthenticationError) AuthenticationError 

func (ae AuthenticationError) AuthenticationError() error

type Engine 

type Engine struct {
	*stdcli.Engine
	Client sdk.Interface
}

func New 

func New(name, version string) *Engine

func (*Engine) Command 

func (e *Engine) Command(command, description string, fn HandlerFunc, opts stdcli.CommandOptions)

func (*Engine) CommandWithoutProvider 

func (e *Engine) CommandWithoutProvider(command, description string, fn HandlerFunc, opts stdcli.CommandOptions)

func (*Engine) RegisterCommands 

func (e *Engine) RegisterCommands()

type HandlerFunc 

type HandlerFunc func(sdk.Interface, *stdcli.Context) error

Source Files

View all Source files

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.