codespace¶

import "github.com/ananth/codespace-zed/internal/codespace"

Package codespace wraps the GitHub CLI (gh) to list, create, delete, and SSH into GitHub Codespaces. All GitHub API interactions go through the GHRunner interface so they can be stubbed in tests.

Index¶

func BuildCreateArgs(target config.Target) []string
func DeleteCodespace(runner GHRunner, name string) error
func DescribeCodespace(cs *Codespace, recommended bool) string
func EnsureGHAuth(runner GHRunner) error
func EnsureReachable(runner GHRunner, codespaceName string) error
func FindZedBinary() (string, error)
func GetSSHConfig(runner GHRunner, codespaceName string) (string, error)
func ListAllRepos(runner GHRunner) ([]string, error)
func MatchesTarget(cs *Codespace, t *config.Target) bool
func RequireCommand(name string) error
func UniqueRepos(codespaces []Codespace) []string
type Codespace
func ChooseCodespace(codespaces []Codespace, t *config.Target) (*Codespace, error)
func CreateCodespace(runner GHRunner, target config.Target) (*Codespace, error)
func CreateCodespaceInteractive(runner GHRunner, target config.Target) (*Codespace, error)
func FilterByRepo(codespaces []Codespace, repo string) []Codespace
func FindMatching(codespaces []Codespace, t *config.Target) []Codespace
func ListAllCodespaces(runner GHRunner) ([]Codespace, error)
func ListCodespaces(runner GHRunner, repository string) ([]Codespace, error)
type DefaultGHRunner
func (d DefaultGHRunner) Run(args []string) (string, error)
func (d DefaultGHRunner) RunInteractive(args []string) (string, error)
func (d DefaultGHRunner) RunMerged(args []string) (string, error)
type GHRunner
type GitStatus
type RepoField
func (r *RepoField) UnmarshalJSON(data []byte) error

func BuildCreateArgs¶

func BuildCreateArgs(target config.Target) []string

BuildCreateArgs builds the gh codespace create command arguments.

func DeleteCodespace¶

func DeleteCodespace(runner GHRunner, name string) error

DeleteCodespace deletes a codespace by name.

func DescribeCodespace¶

func DescribeCodespace(cs *Codespace, recommended bool) string

DescribeCodespace returns a human-readable description.

func EnsureGHAuth¶

func EnsureGHAuth(runner GHRunner) error

EnsureGHAuth verifies the user is authenticated with gh.

func EnsureReachable¶

func EnsureReachable(runner GHRunner, codespaceName string) error

EnsureReachable verifies the codespace SSH server is accessible.

func FindZedBinary¶

func FindZedBinary() (string, error)

FindZedBinary returns the path to the Zed editor CLI binary. It checks "zed" first (Zed.app / Homebrew), then "zeditor" (nix).

func GetSSHConfig¶

func GetSSHConfig(runner GHRunner, codespaceName string) (string, error)

GetSSHConfig retrieves the OpenSSH config for a codespace.

func ListAllRepos¶

func ListAllRepos(runner GHRunner) ([]string, error)

ListAllRepos returns all repositories the user has access to.

func MatchesTarget¶

func MatchesTarget(cs *Codespace, t *config.Target) bool

MatchesTarget checks whether a codespace matches a config target.

func RequireCommand¶

func RequireCommand(name string) error

RequireCommand checks that a command is on PATH.

func UniqueRepos¶

func UniqueRepos(codespaces []Codespace) []string

UniqueRepos extracts sorted unique repository names from codespaces.

type Codespace¶

type Codespace struct {
    Name        string     `json:"name"`
    DisplayName string     `json:"displayName,omitempty"`
    Repository  RepoField  `json:"repository"`
    State       string     `json:"state,omitempty"`
    GitStatus   *GitStatus `json:"gitStatus,omitempty"`
}

func ChooseCodespace¶

func ChooseCodespace(codespaces []Codespace, t *config.Target) (*Codespace, error)

ChooseCodespace auto-selects a codespace in non-interactive mode. Returns nil if no match, errors if ambiguous.

func CreateCodespace¶

func CreateCodespace(runner GHRunner, target config.Target) (*Codespace, error)

CreateCodespace creates a new codespace and returns its details.

func CreateCodespaceInteractive¶

func CreateCodespaceInteractive(runner GHRunner, target config.Target) (*Codespace, error)

CreateCodespaceInteractive creates a codespace with terminal access so gh can prompt the user if needed (e.g. machine type selection). Output is shown on the terminal in real time.

func FilterByRepo¶

func FilterByRepo(codespaces []Codespace, repo string) []Codespace

FilterByRepo returns codespaces belonging to a given repository.

func FindMatching¶

func FindMatching(codespaces []Codespace, t *config.Target) []Codespace

FindMatching returns all codespaces matching the target.

func ListAllCodespaces¶

func ListAllCodespaces(runner GHRunner) ([]Codespace, error)

ListAllCodespaces returns all codespaces across all repos.

func ListCodespaces¶

func ListCodespaces(runner GHRunner, repository string) ([]Codespace, error)

ListCodespaces returns all codespaces for a given repository.

type DefaultGHRunner¶

DefaultGHRunner executes real gh commands.

type DefaultGHRunner struct{}

func (DefaultGHRunner) Run¶

func (d DefaultGHRunner) Run(args []string) (string, error)

func (DefaultGHRunner) RunInteractive¶

func (d DefaultGHRunner) RunInteractive(args []string) (string, error)

func (DefaultGHRunner) RunMerged¶

func (d DefaultGHRunner) RunMerged(args []string) (string, error)

type GHRunner¶

GHRunner abstracts the GitHub CLI for testability.

type GHRunner interface {
    Run(args []string) (string, error)
    RunMerged(args []string) (string, error)
    // RunInteractive runs a command with stdin connected and output teed to
    // both a capture buffer and the real terminal. Use this when the gh
    // subprocess may need to prompt the user (e.g. machine-type selection).
    RunInteractive(args []string) (string, error)
}

type GitStatus¶

type GitStatus struct {
    Ref    string `json:"ref,omitempty"`
    Branch string `json:"branch,omitempty"`
}

type RepoField¶

RepoField handles the gh CLI returning repository as either a string or an object.

type RepoField string

func (*RepoField) UnmarshalJSON¶

func (r *RepoField) UnmarshalJSON(data []byte) error

Generated by gomarkdoc