Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

deploy

package

Go to main page

Versions in this module

v0

v0.3.0

Oct 19, 2026

v0.2.0

Oct 15, 2026

Changes in this version

+ const MaxPublishList

+ func FormatBytes(n int64) string

+ func MaxPublishBytes(cfg *config.Config) int64

type Gateway

+ func (g *Gateway) CheckPublish(req *PublishRequest, decode func(i int) ([]byte, *PublishError)) *PublishError

+ func (g *Gateway) Publish(ctx context.Context, req PublishRequest) (*PublishResult, *PublishError)

type GatewayOptions

+ MCPURL string

type Info

+ MCPURL string

+ type PublishError struct

+ ID string

+ Message string

+ RetryAfter time.Duration

+ func (e *PublishError) Error() string

+ type PublishFile struct

+ ContentType string

+ Data []byte

+ Path string

+ type PublishRequest struct

+ ClientIP string

+ ClientName string

+ Delete []string

+ Files []PublishFile

+ GrantID string

+ Overwrite bool

+ Replace bool

+ Site string

+ User *identity.User

+ type PublishResult struct

+ Bytes int64

+ Created bool

+ Deleted int

+ Files int

+ Site string

+ URL string

+ Unchanged int

+ Uploaded int

+ Warnings []string

v0.1.0

Oct 14, 2026

Changes in this version

+ const CodeBadRequest

+ const CodeConflict

+ const CodeForbidden

+ const CodeInternal

+ const CodeNotFound

+ const CodeRateLimited

+ const CodeTooLarge

+ const CodeUnauthenticated

+ const CodeUnsupported

+ const CodeUpstream

+ const DefaultConcurrency

+ const DefaultReadFileMax

+ const DeployTTL

+ const EmbeddedPath

+ const IgnoreFile

+ const MaxPathBytes

+ const ReservedPathPrefix

+ var ErrFileTooLarge = errors.New("deploy: file exceeds the read limit")

+ func DefaultIgnore() []string

+ func HasGitSegment(p string) bool

+ func IgnorePatterns(dir string, extra []string) ([]string, error)

+ func Ignored(rel string, isDir bool, patterns []string) bool

+ func LambdaHandler(h http.Handler) ...

+ func ProtectedIgnore() []string

+ func ValidatePath(p string) string

+ func ValidatePathSyntax(p string) string

+ func WithDefaultIgnore(patterns []string) []string

+ type APIError struct

+ Code string

+ LoginURL string

+ Message string

+ Status int

+ func (e *APIError) Error() string

+ type AuthInfo struct

+ AnonymousDeploy bool

+ CLILoginURL string

+ Device *DeviceInfo

+ Mode string

+ type Client struct

+ BaseURL string

+ HTTP *http.Client

+ Token string

+ UserAgent string

+ func NewClient(baseURL, token string) *Client

+ func (c *Client) DeleteSite(ctx context.Context, site string) error

+ func (c *Client) Deploy(ctx context.Context, site, dir string, opts DeployOptions) (*DeployResult, error)

+ func (c *Client) GetSite(ctx context.Context, site string) (*sites.Meta, error)

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

+ func (c *Client) ListSites(ctx context.Context) ([]sites.Meta, error)

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

+ func (c *Client) ReadFile(ctx context.Context, site, path string, maxBytes int64) ([]byte, error)

+ func (c *Client) Refresh(ctx context.Context, site string) (*sites.Meta, error)

+ func (c *Client) SetOwners(ctx context.Context, site string, add, remove []string) (*sites.Meta, error)

+ func (c *Client) SiteFiles(ctx context.Context, site string) ([]SiteFile, error)

+ type CommitRequest struct

+ Files []FileEntry

+ type CommitResponse struct

+ Deleted int

+ Site sites.Meta

+ URL string

+ type CreateDeployRequest struct

+ Files []FileEntry

+ Message string

+ type CreateDeployResponse struct

+ DeployID string

+ ExpiresAt time.Time

+ Unchanged []string

+ Uploads []Upload

+ type DeployOptions struct

+ Concurrency int

+ DryRun bool

+ Ignore []string

+ Message string

+ Progress func(ProgressEvent)

+ type DeployResult struct

+ Bytes int64

+ Deleted int

+ Files []LocalFile

+ Site sites.Meta

+ URL string

+ Unchanged int

+ Uploaded int

+ type DeviceInfo struct

+ ClientID string

+ Issuer string

+ Scopes []string

+ type ErrorBody struct

+ Error struct{ ... }

+ type FileEntry struct

+ ContentType string

+ Path string

+ SHA256 string

+ Size int64

+ type Gateway struct

+ func NewGateway(opts GatewayOptions) (*Gateway, error)

+ func (g *Gateway) Info() Info

+ func (g *Gateway) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type GatewayOptions struct

+ Auth auth.Authenticator

+ BaseURL string

+ Config *config.Config

+ Logger *slog.Logger

+ OnDeleteSite func(ctx context.Context, site string) error

+ Registry *sites.Registry

+ Store blob.Store

+ Version string

+ type Info struct

+ Auth AuthInfo

+ BaseDomain string

+ GatewayURL string

+ Limits Limits

+ Methods []string

+ Name string

+ PublicURL string

+ RsyncTarget string

+ Storage *blob.Description

+ URLMode string

+ Version string

+ type Limits struct

+ MaxFileBytes int64

+ MaxFiles int

+ MaxSiteBytes int64

+ type LocalFile struct

+ Abs string

+ ContentType string

+ Path string

+ SHA256 string

+ Size int64

+ func CollectFiles(dir string, extra []string) ([]LocalFile, error)

+ type Matcher struct

+ func NewMatcher(patterns []string) *Matcher

+ func (m *Matcher) Ignored(rel string, isDir bool) bool

+ type OwnersRequest struct

+ Add []string

+ Remove []string

+ type ProgressEvent struct

+ Bytes int64

+ Done int

+ Path string

+ Phase string

+ Total int

+ type SiteFile struct

+ Path string

+ SHA256 string

+ Size int64

+ UpdatedAt time.Time

+ type Upload struct

+ Headers map[string]string

+ Method string

+ Path string

+ URL string