api

package

Go to main page

Versions in this module

v0

v0.1.55

Dec 16, 2025

v0.1.54

Dec 10, 2025

v0.1.53

Dec 7, 2025

v0.1.52

Dec 7, 2025

v0.1.51

Dec 4, 2025

Changes in this version

type Client

+ func (c *Client) PersistPlay(ctx context.Context, id string) error

v0.1.50

Nov 20, 2025

Changes in this version

type Play

+ func (p *Play) FactoryID() string

+ func (p *Play) State() PlayState

type PlayStatus

+ FactoryID string

v0.1.49

Nov 20, 2025

Changes in this version

type Client

+ func (c *Client) DestroyPlay(ctx context.Context, id string) error

+ func (c *Client) RestartPlay(ctx context.Context, id string) (*Play, error)

+ func (c *Client) StopPlay(ctx context.Context, id string) (*Play, error)

type MachineDrive

+ Persistent bool

+ Snapshot *RemoteSnapshot

+ type MachineKernel struct

+ Snapshot *RemoteSnapshot

+ Source string

type Play

+ Status *PlayStatus

+ func (p *Play) IsActive() bool

+ func (p *Play) StateIs(state PlayState) bool

+ type PlayState string

+ const StateCreated

+ const StateDestroyed

+ const StateDestroying

+ const StateFailed

+ const StateRunning

+ const StateStarting

+ const StateStopped

+ const StateStopping

+ const StateWarmedUp

+ const StateWarmingUp

+ type PlayStatus struct

+ StateEvents []StateEvent

type PlaygroundMachine

+ func (m *PlaygroundMachine) UnmarshalYAML(node *yaml.Node) error

+ type RemoteSnapshot struct

+ ID string

+ LeaseID string

+ type StateEvent struct

+ At string

+ Error bool

+ State PlayState

v0.1.48

Sep 3, 2025

Changes in this version

type Play

+ func (p *Play) CountCompletedTasks() int

+ func (p *Play) CountTasks() int

v0.1.47

Aug 8, 2025

Changes in this version

+ var ErrRateLimitExceeded = errors.New("rate limit exceeded")

v0.1.46

Aug 1, 2025

Changes in this version

type PlaygroundMachine

+ NoSSH bool

v0.1.45

Jul 28, 2025

Changes in this version

type PlaygroundTab

+ Access string

v0.1.44

Jul 12, 2025

v0.1.43

Jul 9, 2025

v0.1.42

Jul 8, 2025

v0.1.41

Jul 7, 2025

Changes in this version

type StartChallengeOptions

+ AsFreeTierUser bool

type StartTutorialOptions

+ AsFreeTierUser bool

v0.1.40

Jul 6, 2025

v0.1.39

Jul 5, 2025

v0.1.38

Jun 25, 2025

v0.1.37

Jun 21, 2025

v0.1.36

Jun 14, 2025

Changes in this version

type Client

+ func (c *Client) CompleteTutorial(ctx context.Context, name string) (*Tutorial, error)

+ func (c *Client) StartTutorial(ctx context.Context, name string, opts StartTutorialOptions) (*Tutorial, error)

+ func (c *Client) StopTutorial(ctx context.Context, name string) (*Tutorial, error)

type CreatePlayRequest

+ AsFreeTierUser bool

+ InitConditions *InitConditions

+ InitTasks map[string]InitTask

+ Machines []PlaygroundMachine

+ Networks []PlaygroundNetwork

+ Tabs []PlaygroundTab

+ type ListTutorialsOptions struct

+ Category []string

+ Status []string

+ type StartTutorialOptions struct

+ SafetyDisclaimerConsent bool

type Tutorial

+ AttemptCount int

+ Categories []string

+ CompletionCount int

+ Description string

+ Play *Play

+ Tags []string

v0.1.35

Jun 13, 2025

Changes in this version

type CreatePlaygroundRequest

+ Networks []PlaygroundNetwork

+ type MachineDrive struct

+ Filesystem string

+ Mount string

+ ReadOnly bool

+ Size string

+ Source string

+ type MachineNetwork struct

+ Interfaces []MachineNetworkInterface

+ type MachineNetworkInterface struct

+ Address string

+ Network string

type Playground

+ Networks []PlaygroundNetwork

type PlaygroundMachine

+ Drives []MachineDrive

+ Kernel string

+ Network MachineNetwork

+ type PlaygroundNetwork struct

+ Gateway string

+ Name string

+ Private bool

+ Subnet string

type PlaygroundSpec

+ Networks []PlaygroundNetwork

type PlaygroundTab

+ URL string

type UpdatePlaygroundRequest

+ Networks []PlaygroundNetwork

v0.1.34

May 9, 2025

Changes in this version

+ var ErrAuthenticationRequired = errors.New("authentication required")

+ var ErrGatewayTimeout = errors.New("gateway timeout")

+ var ErrNotFound = errors.New("not found")

+ type AccessMode string

+ const AccessPrivate

+ const AccessPublic

+ type Author struct

+ DisplayName string

+ ExternalProfileURL string

+ Official bool

+ UserID string

+ type Challenge struct

+ AttemptCount int

+ Authors []Author

+ Categories []string

+ CompletionCount int

+ CreatedAt string

+ Description string

+ Name string

+ PageURL string

+ Play *Play

+ Tags []string

+ Tasks map[string]PlayTask

+ Title string

+ UpdatedAt string

+ func (ch *Challenge) GetKind() content.ContentKind

+ func (ch *Challenge) GetName() string

+ func (ch *Challenge) GetPageURL() string

+ func (ch *Challenge) IsAuthoredBy(userID string) bool

+ func (ch *Challenge) IsOfficial() bool

+ type Client struct

+ func NewClient(opts ClientOptions) *Client

+ func (c *Client) CompleteChallenge(ctx context.Context, name string) (*Challenge, error)

+ func (c *Client) CreateAuthor(ctx context.Context, req CreateAuthorRequest) (*Author, error)

+ func (c *Client) CreateChallenge(ctx context.Context, req CreateChallengeRequest) (*Challenge, error)

+ func (c *Client) CreateCourse(ctx context.Context, req CreateCourseRequest) (*Course, error)

+ func (c *Client) CreatePlay(ctx context.Context, req CreatePlayRequest) (*Play, error)

+ func (c *Client) CreatePlayground(ctx context.Context, req CreatePlaygroundRequest) (*Playground, error)

+ func (c *Client) CreateRoadmap(ctx context.Context, req CreateRoadmapRequest) (*Roadmap, error)

+ func (c *Client) CreateSession(ctx context.Context) (*Session, error)

+ func (c *Client) CreateSkillPath(ctx context.Context, req CreateSkillPathRequest) (*SkillPath, error)

+ func (c *Client) CreateTraining(ctx context.Context, req CreateTrainingRequest) (*Training, error)

+ func (c *Client) CreateTutorial(ctx context.Context, req CreateTutorialRequest) (*Tutorial, error)

+ func (c *Client) Delete(ctx context.Context, path string, query url.Values, headers http.Header) (*http.Response, error)

+ func (c *Client) DeleteChallenge(ctx context.Context, name string) error

+ func (c *Client) DeleteContentFile(ctx context.Context, kind content.ContentKind, name string, file string) error

+ func (c *Client) DeleteCourse(ctx context.Context, name string) error

+ func (c *Client) DeletePlay(ctx context.Context, id string) error

+ func (c *Client) DeletePlayground(ctx context.Context, name string) error

+ func (c *Client) DeleteRoadmap(ctx context.Context, name string) error

+ func (c *Client) DeleteSession(ctx context.Context, id string) error

+ func (c *Client) DeleteSkillPath(ctx context.Context, name string) error

+ func (c *Client) DeleteTraining(ctx context.Context, name string) error

+ func (c *Client) DeleteTutorial(ctx context.Context, name string) error

+ func (c *Client) Download(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) DownloadContentFile(ctx context.Context, kind content.ContentKind, name string, file string, ...) error

+ func (c *Client) DownloadTo(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) ExposePort(ctx context.Context, id string, req ExposePortRequest) (*Port, error)

+ func (c *Client) ExposeShell(ctx context.Context, id string, req ExposeShellRequest) (*Shell, error)

+ func (c *Client) Get(ctx context.Context, path string, query url.Values, headers http.Header) (*http.Response, error)

+ func (c *Client) GetAuthor(ctx context.Context) (*Author, error)

+ func (c *Client) GetChallenge(ctx context.Context, name string) (*Challenge, error)

+ func (c *Client) GetCourse(ctx context.Context, name string) (*Course, error)

+ func (c *Client) GetInto(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) GetMe(ctx context.Context) (*Me, error)

+ func (c *Client) GetPlay(ctx context.Context, id string) (*Play, error)

+ func (c *Client) GetPlayground(ctx context.Context, name string, opts *GetPlaygroundOptions) (*Playground, error)

+ func (c *Client) GetRoadmap(ctx context.Context, name string) (*Roadmap, error)

+ func (c *Client) GetSession(ctx context.Context, id string) (*Session, error)

+ func (c *Client) GetSkillPath(ctx context.Context, name string) (*SkillPath, error)

+ func (c *Client) GetTraining(ctx context.Context, name string) (*Training, error)

+ func (c *Client) GetTutorial(ctx context.Context, name string) (*Tutorial, error)

+ func (c *Client) ListAuthoredChallenges(ctx context.Context) ([]Challenge, error)

+ func (c *Client) ListAuthoredCourses(ctx context.Context) ([]Course, error)

+ func (c *Client) ListAuthoredRoadmaps(ctx context.Context) ([]Roadmap, error)

+ func (c *Client) ListAuthoredSkillPaths(ctx context.Context) ([]SkillPath, error)

+ func (c *Client) ListAuthoredTrainings(ctx context.Context) ([]Training, error)

+ func (c *Client) ListAuthoredTutorials(ctx context.Context) ([]Tutorial, error)

+ func (c *Client) ListChallenges(ctx context.Context, opts *ListChallengesOptions) ([]*Challenge, error)

+ func (c *Client) ListContentFiles(ctx context.Context, kind content.ContentKind, name string) ([]string, error)

+ func (c *Client) ListCourses(ctx context.Context) ([]Course, error)

+ func (c *Client) ListPlaygrounds(ctx context.Context, opts *ListPlaygroundsOptions) ([]Playground, error)

+ func (c *Client) ListPlays(ctx context.Context) ([]*Play, error)

+ func (c *Client) ListPorts(ctx context.Context, id string) ([]*Port, error)

+ func (c *Client) ListRoadmaps(ctx context.Context) ([]Roadmap, error)

+ func (c *Client) ListShells(ctx context.Context, id string) ([]*Shell, error)

+ func (c *Client) ListSkillPaths(ctx context.Context) ([]SkillPath, error)

+ func (c *Client) ListTrainings(ctx context.Context) ([]Training, error)

+ func (c *Client) ListTutorials(ctx context.Context) ([]Tutorial, error)

+ func (c *Client) Patch(ctx context.Context, path string, query url.Values, headers http.Header, ...) (*http.Response, error)

+ func (c *Client) PatchInto(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) Post(ctx context.Context, path string, query url.Values, headers http.Header, ...) (*http.Response, error)

+ func (c *Client) PostInto(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) Put(ctx context.Context, path string, query url.Values, headers http.Header, ...) (*http.Response, error)

+ func (c *Client) PutContentMarkdown(ctx context.Context, kind content.ContentKind, name string, file string, ...) error

+ func (c *Client) PutInto(ctx context.Context, path string, query url.Values, headers http.Header, ...) error

+ func (c *Client) RequestPlayConn(ctx context.Context, id string) (*PlayConnHandle, error)

+ func (c *Client) SetCredentials(sessionID, accessToken string)

+ func (c *Client) StartChallenge(ctx context.Context, name string, opts StartChallengeOptions) (*Challenge, error)

+ func (c *Client) StartTunnel(ctx context.Context, id string, req StartTunnelRequest) (*StartTunnelResponse, error)

+ func (c *Client) StopChallenge(ctx context.Context, name string) (*Challenge, error)

+ func (c *Client) UnexposePort(ctx context.Context, id string, portID string) error

+ func (c *Client) UnexposeShell(ctx context.Context, id string, shellID string) error

+ func (c *Client) UpdatePlayground(ctx context.Context, name string, req UpdatePlaygroundRequest) (*Playground, error)

+ func (c *Client) Upload(ctx context.Context, url string, src io.Reader) (*http.Response, error)

+ func (c *Client) UploadContentFile(ctx context.Context, kind content.ContentKind, name string, file string, ...) error

+ func (c *Client) UploadFrom(ctx context.Context, url string, file string) (*http.Response, error)

+ type ClientOptions struct

+ APIBaseURL string

+ AccessToken string

+ BaseURL string

+ SessionID string

+ UserAgent string

+ type Course struct

+ Authors []Author

+ CreatedAt string

+ Name string

+ PageURL string

+ Title string

+ UpdatedAt string

+ func (c *Course) GetKind() content.ContentKind

+ func (c *Course) GetName() string

+ func (c *Course) GetPageURL() string

+ func (c *Course) IsAuthoredBy(userID string) bool

+ func (c *Course) IsOfficial() bool

+ type CourseVariant string

+ const CourseVariantModular

+ const CourseVariantSimple

+ type CreateAuthorRequest struct

+ type CreateChallengeRequest struct

+ Name string

+ Sample bool

+ type CreateCourseRequest struct

+ Name string

+ Sample bool

+ Variant CourseVariant

+ type CreatePlayRequest struct

+ Playground string

+ SafetyDisclaimerConsent bool

+ type CreatePlaygroundRequest struct

+ AccessControl PlaygroundAccessControl

+ Base string

+ Categories []string

+ Description string

+ InitConditions InitConditions

+ InitTasks map[string]InitTask

+ Machines []PlaygroundMachine

+ Markdown string

+ Name string

+ RegistryAuth string

+ Tabs []PlaygroundTab

+ Title string

+ type CreateRoadmapRequest struct

+ Name string

+ Sample bool

+ type CreateSkillPathRequest struct

+ Name string

+ Sample bool

+ type CreateTrainingRequest struct

+ Name string

+ Sample bool

+ type CreateTutorialRequest struct

+ Name string

+ Sample bool

+ type ExposePortRequest struct

+ Access AccessMode

+ HostRewrite string

+ Machine string

+ Number int

+ PathRewrite string

+ TLS bool

+ type ExposeShellRequest struct

+ Access AccessMode

+ Machine string

+ User string

+ type GetPlaygroundOptions struct

+ Format string

+ type InitCondition struct

+ Key string

+ Value string

+ type InitConditionValue struct

+ Default string

+ Key string

+ Nullable bool

+ Options []string

+ type InitConditions struct

+ Values []InitConditionValue

+ type InitTask struct

+ Conditions []InitCondition

+ Init bool

+ Machine string

+ Name string

+ Needs []string

+ Run string

+ Status int

+ TimeoutSeconds int

+ User string

+ type ListChallengesOptions struct

+ Category []string

+ Status []string

+ type ListPlaygroundsOptions struct

+ Filter string

+ type Machine struct

+ Name string

+ Resources MachineResources

+ Users []MachineUser

+ func (m *Machine) DefaultUser() *MachineUser

+ func (m *Machine) HasUser(name string) bool

+ type MachineResources struct

+ CPUCount int

+ RAMSize string

+ type MachineStartupFile struct

+ Append bool

+ Content string

+ Mode string

+ Owner string

+ Path string

+ type MachineUser struct

+ Default bool

+ Name string

+ Welcome string

+ type Me struct

+ GithubProfileId string

+ ID string

+ PremiumAccess *PremiumAccess

+ type Play struct

+ Active bool

+ Challenge ...

+ ChallengeName string

+ Course ...

+ CourseName string

+ CreatedAt string

+ Destroyed bool

+ ExpiresIn int

+ Failed bool

+ ID string

+ LastStateAt string

+ Lesson ...

+ LessonPath string

+ Machines []Machine

+ PageURL string

+ Playground Playground

+ Running bool

+ Tasks map[string]PlayTask

+ Tutorial ...

+ TutorialName string

+ UpdatedAt string

+ func (p *Play) CountCompletedInitTasks() int

+ func (p *Play) CountInitTasks() int

+ func (p *Play) GetMachine(name string) *Machine

+ func (p *Play) IsCompletable() bool

+ func (p *Play) IsFailed() bool

+ func (p *Play) IsInitialized() bool

+ type PlayConn struct

+ func NewPlayConn(ctx context.Context, play *Play, client *Client, origin string) *PlayConn

+ func (pc *PlayConn) Close()

+ func (pc *PlayConn) Start() error

+ func (pc *PlayConn) WaitDone() error

+ func (pc *PlayConn) WaitPlayReady(timeout time.Duration, s *spinner.Spinner) error

+ type PlayConnHandle struct

+ URL string

+ type PlayConnMessage struct

+ Kind string

+ Machine string

+ Task PlayTask

+ type PlayTask struct

+ Helper bool

+ Init bool

+ Name string

+ Status PlayTaskStatus

+ Version int

+ type PlayTaskStatus int

+ const PlayTaskStatusBlocked

+ const PlayTaskStatusCompleted

+ const PlayTaskStatusCreated

+ const PlayTaskStatusFailed

+ const PlayTaskStatusNone

+ const PlayTaskStatusRunning

+ type Playground struct

+ AccessControl PlaygroundAccessControl

+ Base string

+ Categories []string

+ Cover string

+ Description string

+ ID string

+ InitConditions InitConditions

+ InitTasks map[string]InitTask

+ Machines []PlaygroundMachine

+ Markdown string

+ Name string

+ Owner string

+ PageURL string

+ Published bool

+ RegistryAuth string

+ Tabs []PlaygroundTab

+ Title string

+ UserAccess PlaygroundUserAccess

+ type PlaygroundAccess struct

+ Mode string

+ Users []string

+ type PlaygroundAccessControl struct

+ CanList []string

+ CanRead []string

+ CanStart []string

+ type PlaygroundMachine struct

+ Name string

+ Resources MachineResources

+ StartupFiles []MachineStartupFile

+ Users []MachineUser

+ type PlaygroundManifest struct

+ Base string

+ Categories []string

+ Cover string

+ Description string

+ Kind string

+ Markdown string

+ Name string

+ Playground PlaygroundSpec

+ Title string

+ type PlaygroundSpec struct

+ Access *PlaygroundAccess

+ AccessControl PlaygroundAccessControl

+ InitConditions InitConditions

+ InitTasks map[string]InitTask

+ Machines []PlaygroundMachine

+ RegistryAuth string

+ Tabs []PlaygroundTab

+ func (s *PlaygroundSpec) HasAccessControl() bool

+ type PlaygroundTab struct

+ HostRewrite string

+ ID string

+ Kind string

+ Machine string

+ Name string

+ Number int

+ PathRewrite string

+ Tls bool

+ type PlaygroundUserAccess struct

+ CanList bool

+ CanRead bool

+ CanStart bool

+ type Port struct

+ AccessMode AccessMode

+ HostRewrite string

+ Hostname string

+ ID string

+ Machine string

+ Number int

+ PathRewrite string

+ PlayID string

+ TLS bool

+ URL string

+ type PortAccess string

+ const PortAccessPrivate

+ const PortAccessPublic

+ type PremiumAccess struct

+ Lifetime bool

+ Trial bool

+ Until string

+ type Roadmap struct

+ Authors []Author

+ CreatedAt string

+ Name string

+ PageURL string

+ Title string

+ UpdatedAt string

+ func (t *Roadmap) GetKind() content.ContentKind

+ func (t *Roadmap) GetName() string

+ func (t *Roadmap) GetPageURL() string

+ func (t *Roadmap) IsAuthoredBy(userID string) bool

+ func (t *Roadmap) IsOfficial() bool

+ type Session struct

+ AccessToken string

+ AuthURL string

+ Authenticated bool

+ ID string

+ UserID string

+ type Shell struct

+ AccessMode AccessMode

+ Hostname string

+ ID string

+ Machine string

+ PlayID string

+ URL string

+ User string

+ type SkillPath struct

+ Authors []Author

+ CreatedAt string

+ Name string

+ PageURL string

+ Title string

+ UpdatedAt string

+ func (t *SkillPath) GetKind() content.ContentKind

+ func (t *SkillPath) GetName() string

+ func (t *SkillPath) GetPageURL() string

+ func (t *SkillPath) IsAuthoredBy(userID string) bool

+ func (t *SkillPath) IsOfficial() bool

+ type StartChallengeOptions struct

+ SafetyDisclaimerConsent bool

+ type StartTunnelRequest struct

+ Access PortAccess

+ GenerateLoginURL bool

+ Machine string

+ Port int

+ SSHPubKey string

+ SSHUser string

+ type StartTunnelResponse struct

+ LoginURL string

+ URL string

+ type Training struct

+ Authors []Author

+ CreatedAt string

+ Name string

+ PageURL string

+ Title string

+ UpdatedAt string

+ func (t *Training) GetKind() content.ContentKind

+ func (t *Training) GetName() string

+ func (t *Training) GetPageURL() string

+ func (t *Training) IsAuthoredBy(userID string) bool

+ func (t *Training) IsOfficial() bool

+ type Tutorial struct

+ Authors []Author

+ CreatedAt string

+ Name string

+ PageURL string

+ Title string

+ UpdatedAt string

+ func (t *Tutorial) GetKind() content.ContentKind

+ func (t *Tutorial) GetName() string

+ func (t *Tutorial) GetPageURL() string

+ func (t *Tutorial) IsAuthoredBy(userID string) bool

+ func (t *Tutorial) IsOfficial() bool

+ type UpdatePlaygroundRequest struct

+ AccessControl PlaygroundAccessControl

+ Categories []string

+ Cover string

+ Description string

+ InitConditions InitConditions

+ InitTasks map[string]InitTask

+ Machines []PlaygroundMachine

+ Markdown string

+ RegistryAuth string

+ Tabs []PlaygroundTab

+ Title string

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