codespace

Documentation

Index

• Constants
• Variables
• func NewCmdCodespace(f *cmdutil.Factory) *cobra.Command
• type App
  • func NewApp(io *iostreams.IOStreams, exe executable, apiClient apiClient, ...) *App
  • func (a *App) Copy(ctx context.Context, args []string, opts cpOptions) error
  • func (a *App) Create(ctx context.Context, opts createOptions) error
  • func (a *App) Delete(ctx context.Context, opts deleteOptions) (err error)
  • func (a *App) Edit(ctx context.Context, opts editOptions) error
  • func (a *App) ForwardPorts(ctx context.Context, selector *CodespaceSelector, ports []string) (err error)
  • func (a *App) Jupyter(ctx context.Context, selector *CodespaceSelector) (err error)
  • func (a *App) List(ctx context.Context, opts *listOptions, exporter cmdutil.Exporter) error
  • func (a *App) ListPorts(ctx context.Context, selector *CodespaceSelector, exporter cmdutil.Exporter) (err error)
  • func (a *App) Logs(ctx context.Context, selector *CodespaceSelector, follow bool) (err error)
  • func (a *App) Rebuild(ctx context.Context, selector *CodespaceSelector, full bool) (err error)
  • func (a *App) RunWithProgress(label string, run func() error) error
  • func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err error)
  • func (a *App) Select(ctx context.Context, opts selectOptions) (err error)
  • func (a *App) StartProgressIndicatorWithLabel(s string)
  • func (a *App) StopCodespace(ctx context.Context, opts *stopOptions) error
  • func (a *App) StopProgressIndicator()
  • func (a *App) UpdatePortVisibility(ctx context.Context, selector *CodespaceSelector, args []string) (err error)
  • func (a *App) VSCode(ctx context.Context, selector *CodespaceSelector, useInsiders bool, ...) error
  • func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions) error
• type CodespaceSelector
  • func AddCodespaceSelector(cmd *cobra.Command, api apiClient) *CodespaceSelector
  • func (cs *CodespaceSelector) Select(ctx context.Context) (codespace *api.Codespace, err error)
  • func (cs *CodespaceSelector) SelectName(ctx context.Context) (string, error)
• type NullableDuration
  • func (d *NullableDuration) Minutes() *int
  • func (d *NullableDuration) Set(str string) error
  • func (d *NullableDuration) String() string
  • func (d *NullableDuration) Type() string
• type Prompter
  • func (p *Prompter) Ask(qs []*survey.Question, response interface{}) error
• type SurveyPrompter

Constants

const (
	DEVCONTAINER_PROMPT_DEFAULT = "Default Codespaces configuration"
)

Variables

var (
	DEFAULT_DEVCONTAINER_DEFINITIONS = []string{".devcontainer.json", ".devcontainer/devcontainer.json"}
)

var ErrTooManyArgs = errors.New("the command accepts no arguments")

Functions

func NewCmdCodespace

func NewCmdCodespace(f *cmdutil.Factory) *cobra.Command

Types

type App

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

func NewApp

func NewApp(io *iostreams.IOStreams, exe executable, apiClient apiClient, browser browser.Browser, remotes func() (clicontext.Remotes, error)) *App

func (*App) Copy

func (a *App) Copy(ctx context.Context, args []string, opts cpOptions) error

Copy copies files between the local and remote file systems. The mechanics are similar to 'ssh' but using 'scp'.

func (*App) Create

func (a *App) Create(ctx context.Context, opts createOptions) error

Create creates a new Codespace

func (*App) Delete

func (a *App) Delete(ctx context.Context, opts deleteOptions) (err error)

func (*App) Edit

func (a *App) Edit(ctx context.Context, opts editOptions) error

Edits a codespace

func (*App) ForwardPorts

func (a *App) ForwardPorts(ctx context.Context, selector *CodespaceSelector, ports []string) (err error)

func (*App) Jupyter

func (a *App) Jupyter(ctx context.Context, selector *CodespaceSelector) (err error)

func (*App) List

func (a *App) List(ctx context.Context, opts *listOptions, exporter cmdutil.Exporter) error

func (*App) ListPorts

func (a *App) ListPorts(ctx context.Context, selector *CodespaceSelector, exporter cmdutil.Exporter) (err error)

ListPorts lists known ports in a codespace.

func (*App) Logs

func (a *App) Logs(ctx context.Context, selector *CodespaceSelector, follow bool) (err error)

func (*App) Rebuild

func (a *App) Rebuild(ctx context.Context, selector *CodespaceSelector, full bool) (err error)

func (*App) RunWithProgress

func (a *App) RunWithProgress(label string, run func() error) error

func (*App) SSH

func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err error)

SSH opens an ssh session or runs an ssh command in a codespace.

func (*App) Select

func (a *App) Select(ctx context.Context, opts selectOptions) (err error)

Hidden codespace `select` command allows to reuse existing codespace selection dialog by external GH CLI extensions. By default output selected codespace name into `stdout`. Pass `--file`(`-f`) flag along with a file path to output selected codespace name into a file instead.

## Examples

With `stdout` output:

```shell

gh codespace select

```

With `into-a-file` output:

```shell

gh codespace select --file /tmp/selected_codespace.txt

```

func (*App) StartProgressIndicatorWithLabel

func (a *App) StartProgressIndicatorWithLabel(s string)

StartProgressIndicatorWithLabel starts a progress indicator with a message.

func (*App) StopCodespace

func (a *App) StopCodespace(ctx context.Context, opts *stopOptions) error

func (*App) StopProgressIndicator

func (a *App) StopProgressIndicator()

StopProgressIndicator stops the progress indicator.

func (*App) UpdatePortVisibility

func (a *App) UpdatePortVisibility(ctx context.Context, selector *CodespaceSelector, args []string) (err error)

func (*App) VSCode

func (a *App) VSCode(ctx context.Context, selector *CodespaceSelector, useInsiders bool, useWeb bool) error

VSCode opens a codespace in the local VS VSCode application.

func (*App) ViewCodespace

func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions) error

type CodespaceSelector

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

func AddCodespaceSelector

func AddCodespaceSelector(cmd *cobra.Command, api apiClient) *CodespaceSelector

AddCodespaceSelector adds persistent flags for selecting a codespace to the given command and returns a CodespaceSelector which applies them

func (*CodespaceSelector) Select

func (cs *CodespaceSelector) Select(ctx context.Context) (codespace *api.Codespace, err error)

func (*CodespaceSelector) SelectName

func (cs *CodespaceSelector) SelectName(ctx context.Context) (string, error)

type NullableDuration

type NullableDuration struct {
	*time.Duration
}

func (*NullableDuration) Minutes

func (d *NullableDuration) Minutes() *int

func (*NullableDuration) Set

func (d *NullableDuration) Set(str string) error

func (*NullableDuration) String

func (d *NullableDuration) String() string

func (*NullableDuration) Type

func (d *NullableDuration) Type() string

type Prompter

type Prompter struct{}

func (*Prompter) Ask

func (p *Prompter) Ask(qs []*survey.Question, response interface{}) error

ask asks survey questions on the terminal, using standard options. It fails unless hasTTY, but ideally callers should avoid calling it in that case.

type SurveyPrompter

type SurveyPrompter interface {
	Ask(qs []*survey.Question, response interface{}) error
}