cmd

package
v0.0.295-pre-1 Latest Latest
Warning

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

Go to latest
Published: Feb 2, 2022 License: Apache-2.0 Imports: 70 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func MarshalED25519PrivateKey added in v0.0.172

func MarshalED25519PrivateKey(key ed25519.PrivateKey, comment string) []byte

stolen from `mikesmitty`, thanks, you are a mikesmitty and a scholar

func NewRootCmd added in v0.0.189

func NewRootCmd(client *client.Client) *cobra.Command

Types

type BoolFlagOpts

type BoolFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     bool
	EnvName     string
	Hidden      bool
}

BoolFlagOpts - options for boolean flags

type Command

type Command struct {
	*cobra.Command
}

Command - Wrapper for a cobra command

func BuildCommand

func BuildCommand(parent *Command, fn RunFn, usageText string, shortHelpText string, longHelpText string, client *client.Client, options ...Option) *Command

BuildCommand - builds a functioning Command using all the initializers

func BuildCommandCobra added in v0.0.236

func BuildCommandCobra(parent *Command, fn RunFn, cmd *cobra.Command, client *client.Client, options ...Option) *Command

func BuildCommandKS added in v0.0.138

func BuildCommandKS(parent *Command, fn RunFn, keystrings docstrings.KeyStrings, client *client.Client, options ...Option) *Command

BuildCommandKS - A wrapper for BuildCommand which takes the docs.KeyStrings bundle instead of the coder having to manually unwrap it

func (*Command) AddBoolFlag

func (c *Command) AddBoolFlag(options BoolFlagOpts)

AddBoolFlag - Add a boolean flag for a command

func (*Command) AddCommand

func (c *Command) AddCommand(commands ...*Command)

AddCommand adds subcommands to this command

func (*Command) AddIntFlag added in v0.0.121

func (c *Command) AddIntFlag(options IntFlagOpts)

AddIntFlag - Add an integer flag to a command

func (*Command) AddStringFlag

func (c *Command) AddStringFlag(options StringFlagOpts)

AddStringFlag - Add a string flag to a command

func (*Command) AddStringSliceFlag added in v0.0.84

func (c *Command) AddStringSliceFlag(options StringSliceFlagOpts)

AddStringSliceFlag - add a string slice flag to a command

type Initializer

type Initializer struct {
	Setup  InitializerFn
	PreRun InitializerFn
}

Initializer - Retains Setup and PreRun functions

type InitializerFn

type InitializerFn func(*cmdctx.CmdContext) error

InitializerFn - A wrapper for an Initializer function that takes a command context

type IntFlagOpts added in v0.0.121

type IntFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     int
	EnvName     string
	Hidden      bool
}

IntFlagOpts - options for integer flags

type Option added in v0.0.135

type Option func(*Command) Initializer

Option - A wrapper for an Initializer function that takes a command

type PeerStatusJson added in v0.0.179

type PeerStatusJson struct {
	Us     string `json:"us"`
	Them   string `json:"them"`
	Pubkey string `json:"key"`
	Error  string `json:"error"`
}

type PostgresCmd added in v0.0.263

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

func NewPostgresCmd added in v0.0.263

func NewPostgresCmd(cmdCtx *cmdctx.CmdContext, app *api.App, dialer agent.Dialer) *PostgresCmd

func (*PostgresCmd) CreateDatabase added in v0.0.263

func (pc *PostgresCmd) CreateDatabase(dbName string) (*PostgresCommandResponse, error)

func (*PostgresCmd) CreateUser added in v0.0.263

func (pc *PostgresCmd) CreateUser(userName, pwd string) (*PostgresCommandResponse, error)

func (*PostgresCmd) DbExists added in v0.0.263

func (pc *PostgresCmd) DbExists(dbName string) (bool, error)

func (*PostgresCmd) DeleteUser added in v0.0.263

func (pc *PostgresCmd) DeleteUser(userName string) (*PostgresCommandResponse, error)

func (*PostgresCmd) GrantAccess added in v0.0.263

func (pc *PostgresCmd) GrantAccess(dbName, username string) (*PostgresCommandResponse, error)

func (*PostgresCmd) ListDatabases added in v0.0.270

func (pc *PostgresCmd) ListDatabases() (*PostgresDatabaseListResponse, error)

func (*PostgresCmd) ListUsers added in v0.0.270

func (pc *PostgresCmd) ListUsers() (*PostgresUserListResponse, error)

func (*PostgresCmd) RevokeAccess added in v0.0.263

func (pc *PostgresCmd) RevokeAccess(dbName, username string) (*PostgresCommandResponse, error)

func (*PostgresCmd) UserExists added in v0.0.263

func (pc *PostgresCmd) UserExists(userName string) (bool, error)

type PostgresCommandResponse added in v0.0.263

type PostgresCommandResponse struct {
	Result bool   `json:"result"`
	Error  string `json:"error"`
}

type PostgresConfiguration added in v0.0.260

type PostgresConfiguration struct {
	Name               string
	Description        string
	ImageRef           string
	InitialClusterSize int
	VmSize             string
	MemoryMb           int
	DiskGb             int
}

type PostgresCreateDatabaseRequest added in v0.0.263

type PostgresCreateDatabaseRequest struct {
	Name string `json:"name"`
}

type PostgresCreateUserRequest added in v0.0.263

type PostgresCreateUserRequest struct {
	Username  string `json:"username"`
	Password  string `json:"password"`
	Superuser bool   `json:"superuser"`
}

type PostgresDatabase added in v0.0.263

type PostgresDatabase struct {
	Name  string
	Users []string
}

type PostgresDatabaseListResponse added in v0.0.263

type PostgresDatabaseListResponse struct {
	Result []PostgresDatabase
}

type PostgresDeleteUserRequest added in v0.0.263

type PostgresDeleteUserRequest struct {
	Username string `json:"username"`
}

type PostgresGrantAccessRequest added in v0.0.263

type PostgresGrantAccessRequest struct {
	Database string `json:"database"`
	Username string `json:"username"`
}

type PostgresRevokeAccessRequest added in v0.0.263

type PostgresRevokeAccessRequest struct {
	Database string `json:"database"`
	Username string `json:"username"`
}

type PostgresUser added in v0.0.263

type PostgresUser struct {
	Username  string
	Superuser bool
	Databases []string
}

type PostgresUserListResponse added in v0.0.263

type PostgresUserListResponse struct {
	Result []PostgresUser
}

type ProxyParams added in v0.0.243

type ProxyParams struct {
	RemoteAddr string
	LocalAddr  string
	Dialer     agent.Dialer
}

type RunFn added in v0.0.135

type RunFn func(cmdContext *cmdctx.CmdContext) error

RunFn - Run function for commands which takes a command context

type SSHParams added in v0.0.183

type SSHParams struct {
	Ctx            *cmdctx.CmdContext
	Org            *api.Organization
	App            string
	Dialer         agent.Dialer
	Cmd            string
	Stdin          io.Reader
	Stdout         io.WriteCloser
	Stderr         io.WriteCloser
	DisableSpinner bool
}

type StartPeerJson added in v0.0.179

type StartPeerJson struct {
	Name   string `json:"name"`
	Group  string `json:"group"`
	Pubkey string `json:"pubkey"`
	Region string `json:"region"`
}

type StringFlagOpts

type StringFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     string
	EnvName     string
	Hidden      bool
}

StringFlagOpts - options for string flags

type StringSliceFlagOpts added in v0.0.84

type StringSliceFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     []string
	EnvName     string
}

StringSliceFlagOpts - options a string slice flag

type UpdatePeerJson added in v0.0.179

type UpdatePeerJson struct {
	Pubkey string `json:"pubkey"`
}

Notes

Bugs

  • do better

  • can't stay this way

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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