k8shell

package module

Go to main page

Versions in this module

v0

v0.2.4

Aug 6, 2026

Changes in this version

type Client

+ func (c *Client) AddRoleBlueprints(ctx context.Context, org, name string, blueprints []string) error

+ func (c *Client) ApproveOnboardRule(ctx context.Context, org string, id int32) (*models.User, error)

+ func (c *Client) CreateOnboardRule(ctx context.Context, org string, req models.OnboardRuleCreateRequest) (*models.OnboardRule, error)

+ func (c *Client) CreateOrganization(ctx context.Context, req models.OrganizationCreateRequest) (*models.Organization, error)

+ func (c *Client) CreateRole(ctx context.Context, org string, req models.RoleCreateRequest) (*models.RoleInfo, error)

+ func (c *Client) DeleteOnboardRule(ctx context.Context, org string, id int32) error

+ func (c *Client) DeleteOrganization(ctx context.Context, name string, req models.OrganizationDeleteRequest) error

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

+ func (c *Client) GetOrganization(ctx context.Context, name string) (*models.Organization, error)

+ func (c *Client) GetRole(ctx context.Context, org, name string) (*models.RoleInfo, error)

+ func (c *Client) ListOnboardRules(ctx context.Context, org string, filter OnboardRuleFilter) ([]models.OnboardRule, error)

+ func (c *Client) ListOrganizations(ctx context.Context) ([]models.Organization, error)

+ func (c *Client) ListRoles(ctx context.Context, org string) ([]models.RoleInfo, error)

+ func (c *Client) RejectOnboardRule(ctx context.Context, org string, id int32, req models.OnboardRuleRejectRequest) (*models.OnboardRule, error)

+ func (c *Client) RemoveRoleBlueprints(ctx context.Context, org, name string, blueprints []string) error

+ func (c *Client) UpdateOnboardRule(ctx context.Context, org string, id int32, req models.OnboardRuleUpdateRequest) (*models.OnboardRule, error)

+ func (c *Client) UpdateOrganization(ctx context.Context, name string, req models.OrganizationUpdateRequest) (*models.Organization, error)

+ func (c *Client) UpdateRole(ctx context.Context, org, name string, req models.RoleUpdateRequest) (*models.RoleInfo, error)

+ type OnboardRuleFilter struct

+ Action string

+ IDP string

+ Status string

v0.2.3

Aug 4, 2026

v0.2.2

Jul 17, 2026

Changes in this version

type Client

+ func (c *Client) CreateUserToken(ctx context.Context, username string, req models.AccessTokenCreateRequest) (*models.AccessTokenCreated, error)

+ func (c *Client) DeleteUserToken(ctx context.Context, username string, id int64) error

+ func (c *Client) GetUserToken(ctx context.Context, username string, id int64) (*models.AccessToken, error)

+ func (c *Client) ListUserTokens(ctx context.Context, username string) ([]models.AccessToken, error)

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

+ func (c *Client) UpdateUserToken(ctx context.Context, username string, id int64, ...) (*models.AccessToken, error)

v0.2.1

Jul 11, 2026

Changes in this version

type Client

+ func (c *Client) ComposeBlueprint(ctx context.Context, username string, k8shellFile *models.K8shellFile) (*models.Blueprint, error)

+ func (c *Client) ResolveUserCredential(ctx context.Context, username, serviceName, scope string) (*models.UserCredential, error)

v0.2.0

Jul 11, 2026

Changes in this version

+ var ErrDryRun = errors.New("dry run: request not sent (--curl)")

type Client

+ func (c *Client) AddGitUserCredential(ctx context.Context, username string, req models.UserGitCredentialRequest) (*models.UserCredential, error)

+ func (c *Client) AddKubernetesUserCredential(ctx context.Context, username string, ...) (*models.UserCredential, error)

+ func (c *Client) AddRegistryUserCredential(ctx context.Context, username string, req models.UserRegistryCredentialRequest) (*models.UserCredential, error)

+ func (c *Client) AddUserBlueprints(ctx context.Context, username string, blueprints []string) error

+ func (c *Client) AddUserKeys(ctx context.Context, username string, keys []string) error

+ func (c *Client) AddUserRoles(ctx context.Context, username string, roles []models.Role) error

+ func (c *Client) ClearUserPasswordLockout(ctx context.Context, username string) error

+ func (c *Client) CreateUser(ctx context.Context, req models.UserCreateRequest) (*models.User, error)

+ func (c *Client) DeleteUser(ctx context.Context, username string) error

+ func (c *Client) DeleteUserCredential(ctx context.Context, username string, id uint32) error

+ func (c *Client) GetCapabilities(ctx context.Context, username, resourceOwner string) ([]models.Capability, error)

+ func (c *Client) GetUserBlueprints(ctx context.Context, username string) ([]string, error)

+ func (c *Client) GetUserCredential(ctx context.Context, username string, id uint32) (*models.UserCredential, error)

+ func (c *Client) GetUserProfile(ctx context.Context, username string) (*models.UserProfile, error)

+ func (c *Client) ListUserAuthKeys(ctx context.Context, username string) ([]models.UserAuthKey, error)

+ func (c *Client) ListUserCredentials(ctx context.Context, username string) ([]models.UserCredential, error)

+ func (c *Client) RemoveUserAuthKey(ctx context.Context, username string, index int) error

+ func (c *Client) RemoveUserBlueprints(ctx context.Context, username string, blueprints []string) error

+ func (c *Client) RemoveUserRoles(ctx context.Context, username string, roles []models.Role) error

+ func (c *Client) SetUserPassword(ctx context.Context, username, password, currentPassword string) (*models.User, error)

+ func (c *Client) UpdateUserCredential(ctx context.Context, username string, id uint32, ...) (*models.UserCredential, error)

+ func (c *Client) UpdateUserProfile(ctx context.Context, username string, req models.UserUpdateRequest) (*models.User, error)

type Option

+ func WithCurl() Option

+ func WithCurlLocation() Option

+ func WithCurlVerbose() Option

v0.1.0

Jun 23, 2026

Changes in this version

+ const CapabilityOnboardUserWebFlow

type APIError

+ func (e *APIError) Unwrap() error

type Option

+ func WithDebugWriter(w io.Writer) Option

v0.0.1

Jun 23, 2026

Changes in this version

+ type APIError struct

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ type Client struct

+ func New(server, token string, opts ...Option) *Client

+ func NewAnonymous(server string, opts ...Option) *Client

+ func (c *Client) CreateWorkspace(req WorkspaceCreateRequest) (*WorkspaceCreateResponse, error)

+ func (c *Client) DeleteWorkspace(name string, deleteData bool) error

+ func (c *Client) GetProfile() (*models.User, error)

+ func (c *Client) GetWorkspace(name string) (*models.WorkspaceDetails, error)

+ func (c *Client) ListProviders() ([]string, error)

+ func (c *Client) ListSessions(username string, all bool) ([]models.SSHSession, error)

+ func (c *Client) ListUsers() ([]models.User, error)

+ func (c *Client) ListWorkspaces(username string, all bool) ([]models.WorkspaceDetails, error)

+ func (c *Client) MonitorWorkspace(monitorURL string) (io.ReadCloser, error)

+ func (c *Client) PollToken(state string) (*models.UserToken, error)

+ type Option func(*Client)

+ func WithDebug() Option

+ func WithInsecure() Option

+ type WorkspaceCreateRequest struct

+ Blueprint string

+ RepoName string

+ RepoOwner string

+ RepoRef string

+ Username string

+ type WorkspaceCreateResponse struct

+ JobID string

+ MonitorURL string

+ Workspace string

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