cli

Apr 13, 2026

Changes in this version

+ func ShareCmd() *cobra.Command

+ func ShareImagesCmd() *cobra.Command

+ func UnshareCmd() *cobra.Command

+ func UnshareImagesCmd() *cobra.Command

type Deployment

+ func (d *Deployment) UploadWithRetry(url string, refreshURL func() (string, error)) error

Mar 31, 2026

Changes in this version

+ func PushCmd() *cobra.Command

+ func ValidateBuildConfig(cwd, folder string, config core.Config) string

type ResourceOperationResult

+ func PostThenPutFn(resource *core.Resource, resourceName string, name string, ...) *ResourceOperationResult

Mar 13, 2026

Changes in this version

+ func CompleteSandboxPreviewNames(sandboxName string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteSandboxPreviewTokenNames(sandboxName, previewName, toComplete string) ([]string, cobra.ShellCompDirective)

+ func DeleteSandboxPreviewNestedResource(args []string) bool

+ func HandleSandboxPreviewNestedResource(args []string) bool

Feb 10, 2026

Changes in this version

type ResourceOperationResult

+ MetadataURL string

Jan 28, 2026

Changes in this version

+ func CompleteAgentNames(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteFunctionNames(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteImageNames(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteImageTags(resourceType, imageName, tagPrefix string) ([]string, cobra.ShellCompDirective)

+ func CompleteJobExecutionIDs(jobName string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteJobExecutionTaskIDs(jobName, executionID, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteJobNames(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteModelNames(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompletePolicyNames(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteSandboxNames(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteSandboxProcessNames(sandboxName string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteVolumeNames(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func CompleteWorkspaceNames(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func GetChatValidArgsFunction() ...

+ func GetConnectSandboxValidArgsFunction() ...

+ func GetImageValidArgsFunction() ...

+ func GetJobValidArgsFunction() ...

+ func GetLogsValidArgsFunction() ...

+ func GetNewValidArgsFunction() ...

+ func GetResourceValidArgsFunction(kind string) ...

+ func GetRunValidArgsFunction() ...

+ func GetSandboxValidArgsFunction() ...

+ func GetWorkspaceValidArgsFunction() ...

+ func HandleSandboxNestedResource(args []string) bool

+ type Batch struct

+ Tasks []map[string]interface{}

Jan 14, 2026

Changes in this version

+ func CreateMCPCmd() *cobra.Command

Dec 2, 2025

Changes in this version

type ResourceOperationResult

+ CallbackSecret string

Dec 2, 2025

Changes in this version

+ func HandleJobNestedResource(args []string) bool

Nov 13, 2025

Changes in this version

+ func UpgradeCmd() *cobra.Command

Nov 7, 2025

Changes in this version

+ func DeleteImagesCmd() *cobra.Command

+ func GetImagesCmd() *cobra.Command

+ func ListAllImages()

Oct 14, 2025

Changes in this version

+ func LogsCmd() *cobra.Command

+ func TokenCmd() *cobra.Command

type ResourceOperationResult

+ ErrorMsg string

Oct 9, 2025

Changes in this version

+ func CreateVolumeTemplateCmd() *cobra.Command

+ func RunVolumeTemplateCreation(dirArg string, templateName string, noTTY bool)

type Deployment

+ func (d *Deployment) PrintTar() error

+ func (d *Deployment) Tar() error

Oct 7, 2025

Changes in this version

type Deployment

+ func (d *Deployment) ApplyInteractive() error

Aug 29, 2025

Changes in this version

+ func NewCmd() *cobra.Command

+ func RunAgentAppCreation(dirArg string, templateName string, noTTY bool)

+ func RunJobCreation(dirArg string, templateName string, noTTY bool)

+ func RunMCPCreation(dirArg string, templateName string, noTTY bool)

+ func RunSandboxCreation(dirArg string, templateName string, noTTY bool)

Jul 16, 2025

Changes in this version

+ func CreateSandboxCmd() *cobra.Command

Jun 14, 2025

Changes in this version

+ func ApplyCmd() *cobra.Command

+ func BootChat(ctx context.Context, workspace string, resourceType string, ...) error

+ func Chat(ctx context.Context, workspace string, resourceType string, ...) error

+ func ChatCmd() *cobra.Command

+ func CheckResource(ctx context.Context, workspace string, resourceType string, ...) error

+ func ConnectCmd() *cobra.Command

+ func ConnectSandboxCmd() *cobra.Command

+ func CreateAgentAppCmd() *cobra.Command

+ func CreateJobCmd() *cobra.Command

+ func CreateMCPServerCmd() *cobra.Command

+ func DeleteCmd() *cobra.Command

+ func DeleteFn(resource *core.Resource, name string)

+ func DeployCmd() *cobra.Command

+ func GetCmd() *cobra.Command

+ func GetFn(resource *core.Resource, name string)

+ func ListExec(resource *core.Resource) ([]interface{}, error)

+ func ListFn(resource *core.Resource)

+ func ListOrSetWorkspacesCmd() *cobra.Command

+ func LoginCmd() *cobra.Command

+ func LogoutCmd() *cobra.Command

+ func RunCmd() *cobra.Command

+ func SendMessage(ctx context.Context, workspace string, resourceType string, ...) (string, error)

+ func SendMessageStream(ctx context.Context, workspace string, resourceType string, ...) error

+ func ServeCmd() *cobra.Command

+ func VersionCmd() *cobra.Command

type ApplyResult

+ func Apply(filePath string, opts ...ApplyOption) ([]ApplyResult, error)

+ func ApplyResources(results []core.Result) ([]ApplyResult, error)

type ResourceOperationResult

+ func PostFn(resource *core.Resource, resourceName string, name string, ...) *ResourceOperationResult

+ func PutFn(resource *core.Resource, resourceName string, name string, ...) *ResourceOperationResult

Jun 4, 2025

Changes in this version

type Resource

+ WithImage bool

Jun 4, 2025

Changes in this version

type Operations

+ func (r *Operations) ConnectCmd() *cobra.Command

+ func (r *Operations) ConnectSandbox(ctx context.Context, sandboxName string, debug bool, url string)

+ func (r *Operations) ConnectSandboxCmd() *cobra.Command

Jun 1, 2025

Changes in this version

type Operations

+ func (r *Operations) ExploreCmd() *cobra.Command

+ func (r *Operations) ExploreSandbox(ctx context.Context, sandboxName string, debug bool, url string)

+ func (r *Operations) ExploreSandboxCmd() *cobra.Command

+ func (r *Operations) SendMessageStream(ctx context.Context, workspace string, resourceType string, ...) error

type RootCmdConfig

+ Folder string

May 15, 2025

Changes in this version

type Config

+ SkipRoot bool

May 12, 2025

Changes in this version

type Deployment

+ func (d *Deployment) Ready()

type Operations

+ func (r *Operations) CreateJobCmd() *cobra.Command

type Template

+ Type string

type TemplateOptions

+ TemplateName string

type Templates

+ func (t Templates) Find(name string) (Template, error)

May 10, 2025

Changes in this version

type Env

+ func GetUniqueEnvs() []Env

May 8, 2025

Changes in this version

+ var APP_URL = "https://app.blaxel.ai"

+ var BASE_URL = "https://api.blaxel.ai/v0"

+ var GH_BRANCH = "main"

+ var GH_ORGANIZATION = "blaxel-ai"

+ var GITHUB_RELEASES_URL = "https://api.github.com/repos/beamlit/toolkit/releases/latest"

+ var REGISTRY_URL = "https://us.registry.blaxel.ai"

+ var RUN_URL = "https://run.blaxel.ai"

+ var UPDATE_CLI_DOC_URL = "https://docs.blaxel.ai/cli-reference/introduction#update"

+ func CheckWorkspaceAccess(workspaceName string, credentials sdk.Credentials) (sdk.Workspace, error)

+ func ErrorHandler(request *http.Request, kind string, name string, body string) error

+ func Execute(releaseVersion string, releaseCommit string, releaseDate string) error

+ func GetHuhTheme() *huh.Theme

+ type ApplyOption func(*applyOptions)

+ func WithRecursive(recursive bool) ApplyOption

+ type ApplyResult struct

+ Kind string

+ Name string

+ Result ResourceOperationResult

+ type CommandEnv map[string]string

+ func (c *CommandEnv) AddClientEnv()

+ func (c *CommandEnv) Set(key, value string)

+ func (c *CommandEnv) ToEnv() []string

+ type Config struct

+ Agent map[string]Package

+ Agents []string

+ Entrypoint Entrypoints

+ Env Envs

+ Function map[string]Package

+ Functions []string

+ Models []string

+ Name string

+ Policies []string

+ Protocol string

+ Runtime *map[string]interface{}

+ Triggers *[]map[string]interface{}

+ Type string

+ Workspace string

+ type Deployment struct

+ func (d *Deployment) Apply() error

+ func (d *Deployment) Generate() error

+ func (d *Deployment) GenerateDeployment() Result

+ func (d *Deployment) IgnoredPaths() []string

+ func (d *Deployment) Print() error

+ func (d *Deployment) PrintZip() error

+ func (d *Deployment) Upload(url string) error

+ func (d *Deployment) Zip() error

+ type Entrypoints struct

+ Development string

+ Production string

+ type Env struct

+ Name string

+ Value string

+ func GetEnvs() []Env

+ type Envs map[string]string

+ type ErrorModel struct

+ Code int

+ Error string

+ Stack []string

+ type IgnoreDir struct

+ Folder string

+ Skip string

+ type IgnoreFile struct

+ File string

+ Skip string

+ type NameRetriever struct

+ Metadata struct{ ... }

+ type Operations struct

+ AppURL string

+ BaseURL string

+ RegistryURL string

+ RunURL string

+ func (r *Operations) ApiKeyLogin(workspace string)

+ func (r *Operations) Apply(filePath string, opts ...ApplyOption) ([]ApplyResult, error)

+ func (r *Operations) ApplyCmd() *cobra.Command

+ func (r *Operations) ApplyResources(results []Result) ([]ApplyResult, error)

+ func (r *Operations) BootChat(ctx context.Context, workspace string, resourceType string, ...) error

+ func (r *Operations) Chat(ctx context.Context, workspace string, resourceType string, ...) error

+ func (r *Operations) ChatCmd() *cobra.Command

+ func (r *Operations) CheckResource(ctx context.Context, workspace string, resourceType string, ...) error

+ func (r *Operations) CliCommand(ctx context.Context, operationId string, fn interface{})

+ func (r *Operations) ClientCredentialsLogin(workspace string, clientCredentials string)

+ func (r *Operations) CreateAgentAppCmd() *cobra.Command

+ func (r *Operations) CreateMCPServerCmd() *cobra.Command

+ func (r *Operations) DeleteCmd() *cobra.Command

+ func (r *Operations) DeployCmd() *cobra.Command

+ func (r *Operations) DeviceModeLogin(workspace string)

+ func (r *Operations) DeviceModeLoginFinalize(deviceCode string, workspace string)

+ func (r *Operations) DocCmd() *cobra.Command

+ func (r *Operations) GetCmd() *cobra.Command

+ func (r *Operations) GetRegistryURL() string

+ func (r *Operations) ListOrSetWorkspacesCmd() *cobra.Command

+ func (r *Operations) LoginCmd() *cobra.Command

+ func (r *Operations) LogoutCmd() *cobra.Command

+ func (r *Operations) RunCmd() *cobra.Command

+ func (r *Operations) SeedCache(cwd string) error

+ func (r *Operations) SendMessage(ctx context.Context, workspace string, resourceType string, ...) (string, error)

+ func (r *Operations) ServeCmd() *cobra.Command

+ func (r *Operations) SetBaseURL(url string)

+ func (r *Operations) VersionCmd() *cobra.Command

+ type Package struct

+ Path string

+ Port int

+ Type string

+ type PackageCommand struct

+ Args []string

+ Color string

+ Command string

+ Cwd string

+ Envs CommandEnv

+ Name string

+ type PackageJson struct

+ Scripts map[string]string

+ type RegisterImpl struct

+ type Resource struct

+ Delete interface{}

+ Get interface{}

+ Kind string

+ List interface{}

+ Plural string

+ Post interface{}

+ Put interface{}

+ Short string

+ Singular string

+ SpecType reflect.Type

+ WithStatus bool

+ func (resource Resource) DeleteFn(name string)

+ func (resource Resource) GetFn(name string)

+ func (resource Resource) ListExec() ([]interface{}, error)

+ func (resource Resource) ListFn()

+ func (resource Resource) PostFn(resourceName string, name string, resourceObject interface{}) *ResourceOperationResult

+ func (resource Resource) PutFn(resourceName string, name string, resourceObject interface{}) *ResourceOperationResult

+ type ResourceOperationResult struct

+ Status string

+ UploadURL string

+ type Result struct

+ ApiVersion string

+ Kind string

+ Metadata interface{}

+ Spec interface{}

+ Status string

+ func (r *Result) ToString() string

+ type ResultMetadata struct

+ Name string

+ Workspace string

+ type RootCmdConfig struct

+ Docker bool

+ Entrypoint Entrypoints

+ Envs CommandEnv

+ Hotreload bool

+ Production bool

+ type Secrets []Env

+ type Template struct

+ Id int

+ Language string

+ Name string

+ Topics []string

+ func (t Template) Clone(opts TemplateOptions) error

+ type TemplateConfig struct

+ Variables []struct{ ... }

+ type TemplateOptions struct

+ Author string

+ Directory string

+ IgnoreDirs map[string]IgnoreDir

+ IgnoreFiles map[string]IgnoreFile

+ Language string

+ ProjectName string

+ ProjectPrompt string

+ Template Template

+ TemplateOptions map[string]*string

+ type Templates []Template

+ func RetrieveTemplates(templateType string) (Templates, error)