Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type Capabilities ¶
type Capabilities struct {
Version int `json:"version"`
Sites bool `json:"sites"`
Files bool `json:"files"`
Database bool `json:"database"`
Realtime bool `json:"realtime"`
Identity bool `json:"identity,omitempty"`
AccessControl bool `json:"accessControl,omitempty"`
PermissionVersion int `json:"permissionVersion,omitempty"`
Publishing bool `json:"publishing,omitempty"`
Artifacts bool `json:"artifacts,omitempty"`
Actions bool `json:"actions,omitempty"`
MaxUploadBytes int64 `json:"maxUploadBytes"`
}
func (*Capabilities) UnmarshalJSON ¶
func (c *Capabilities) UnmarshalJSON(data []byte) error
UnmarshalJSON requires the original capabilities and tolerates new ones, so platform upgrades do not break installed CLIs.
type Connection ¶
type Connection struct {
Version int `json:"version"`
Name string `json:"name"`
Server string `json:"server"`
SiteBaseURL string `json:"siteBaseURL"`
CLIReleaseURL string `json:"cliReleaseURL,omitempty"`
Resource string `json:"resource,omitempty"`
ClientID string `json:"clientId,omitempty"`
TenantID string `json:"tenantId,omitempty"`
Auth *hex.AuthConfig `json:"auth,omitempty"`
Capabilities *Capabilities `json:"capabilities"`
// LegacyPublishing is the storage destination older platforms advertised
// and older CLIs saved in profiles. Publishing now goes through the API,
// so it is accepted and ignored.
LegacyPublishing json.RawMessage `json:"publishing,omitempty"`
}
type Project ¶
type Project struct {
Workspace *workspacePin `json:"workspace,omitempty"`
Name string `json:"name"`
Title string `json:"title,omitempty"`
Description string `json:"description,omitempty"`
Author string `json:"author,omitempty"`
Discoverable *bool `json:"discoverable,omitempty"`
Directory string `json:"directory,omitempty"`
Platform string `json:"platform,omitempty"`
Server string `json:"server,omitempty"`
SiteBaseURL string `json:"siteBaseURL,omitempty"`
Resource string `json:"resource,omitempty"`
// Access is the site's access policy, applied by the platform when the
// site is published. The platform validates it.
Access json.RawMessage `json:"access,omitempty"`
// Actions are operations the app exposes to the CLI and agents, performed
// by the platform on the app's documents. The platform validates them.
Actions json.RawMessage `json:"actions,omitempty"`
// Automations are metadata for scheduled or on-demand JavaScript scripts run
// as the site; more can live one per file in automations/*.json.
Automations json.RawMessage `json:"automations,omitempty"`
// ClientID and TenantID come from the platform profile and select the
// CLI's own browser sign-in.
ClientID string `json:"-"`
TenantID string `json:"-"`
Auth *hex.AuthConfig `json:"-"`
Capabilities *Capabilities `json:"-"`
// contains filtered or unexported fields
}
Source Files
¶
- access.go
- actions.go
- agents.go
- agents_opencode.go
- ai.go
- api.go
- app.go
- assets.go
- automatic_update.go
- automations.go
- azure_login.go
- codegen.go
- config.go
- dev.go
- dev_settings.go
- directories.go
- download.go
- events.go
- fetch.go
- files.go
- integrations.go
- mcp.go
- mcp_login.go
- oidc.go
- process.go
- profile_migration.go
- profiles.go
- project.go
- publish_directory.go
- publish_path.go
- publishing.go
- reads.go
- safety.go
- setup.go
- signin.go
- site_codegen.go
- typescript.go
- update.go
- workspaces.go
Click to show internal directories.
Click to hide internal directories.