tailkit

May 27, 2026

Changes in this version

+ var ErrConflict = types.ErrConflict

+ var ErrUnauthorized = types.ErrUnauthorized

+ type AdminClient struct

+ func (a *AdminClient) DeleteService(ctx context.Context, name string) error

+ func (a *AdminClient) PushHostConfig(ctx context.Context, cfg HostConfig) error

+ func (a *AdminClient) PushService(ctx context.Context, name string, cfg OutsiderServiceConfig) error

+ func (a *AdminClient) TransferTo(ctx context.Context, targetHostname string) error

type FleetClient

+ func (f *FleetClient) Hosts(ctx context.Context) (map[string]*Host, map[string]error)

+ func (f *FleetClient) Services(ctx context.Context) []Service

+ type Host struct

+ Arch string

+ Environment string

+ InstanceType string

+ IsAdmin bool

+ Metadata map[string]string

+ Name string

+ OS string

+ Online bool

+ Provider string

+ Role string

+ TSDNSName string

+ TSHostname string

+ TSIPs []string

+ Tags []string

+ func (h *Host) IsClassified() bool

+ type HostConfig struct

+ Environment string

+ InstanceType string

+ Metadata map[string]string

+ Name string

+ Provider string

+ Role string

+ Tags []string

type NodeClient

+ func (n *NodeClient) Admin(adminKey string) *AdminClient

+ func (n *NodeClient) Host(ctx context.Context) (*Host, error)

+ func (n *NodeClient) Hostname() string

+ func (n *NodeClient) Services(ctx context.Context) ([]Service, error)

+ type OutsiderServiceConfig struct

+ BinaryPath string

+ ExpectedPorts []uint16

+ Name string

+ PidFile string

+ Priority string

+ Runtime string

+ SystemdUnit string

+ Tags []string

type Server

+ Config ServerConfig

type ServerConfig

+ PeerCacheTTL time.Duration

+ type Service struct

+ BinaryPath string

+ ExpectedPorts []uint16

+ Name string

+ NodeName string

+ PidFile string

+ Priority string

+ Runtime string

+ Source string

+ SystemdUnit string

+ Tags []string

+ ToolTsHost string

+ ToolVersion string

May 1, 2026

Changes in this version

+ const EventDockerAll

+ const EventDockerContainer

type DockerClient

+ func (n *DockerClient) StreamAll(ctx context.Context, fn func(types.Event[types.DockerEvent]) error) error

+ func (n *DockerClient) StreamContainers(ctx context.Context, fn func(types.Event[types.DockerEvent]) error) error

type Server

+ func (s *Server) StreamHTTPClient() *http.Client

Apr 20, 2026

Changes in this version

type Server

+ func (s *Server) Close() error

+ func (s *Server) HTTPClient() *http.Client

Apr 16, 2026

Changes in this version

+ const EventError

+ func DecodeEvent[T any](raw types.RawEvent) (types.Event[T], error)

+ func Stream[T any](ctx context.Context, node *NodeClient, path string, names []string, ...) error

+ type CPU = types.CPU

+ type JobUpdate = types.JobUpdate

+ type Memory = types.Memory

+ type Metrics = types.Metrics

+ type Port = types.Port

+ type PortUpdate = types.PortUpdate

+ type Process = types.Process

Apr 16, 2026

Changes in this version

+ const EventAll

+ const EventCPU

+ const EventJobCompleted

+ const EventJobFailed

+ const EventJobStatus

+ const EventJobStderr

+ const EventJobStdout

+ const EventJournalEntry

+ const EventLogLine

+ const EventMemory

+ const EventNetwork

+ const EventPortBound

+ const EventPortReleased

+ const EventPortsSnapshot

+ const EventProcesses

+ const EventStatsSnapshot

+ type AllMetrics = types.AllMetrics

type DockerClient

+ func (dc *DockerClient) StreamLogs(ctx context.Context, containerID string, tail int, ...) error

+ func (dc *DockerClient) StreamStats(ctx context.Context, containerID string, ...) error

+ type Event struct

+ Data json.RawMessage

+ ID int64

+ Name string

+ type JobEvent = types.JobEvent

+ type JournalEntry = types.JournalEntry

+ type ListenPort = types.ListenPort

+ type LogLine = types.LogLine

type MetricsClient

+ func (mc *MetricsClient) Ports(ctx context.Context) ([]types.ListenPort, error)

+ func (mc *MetricsClient) PortsAvailable(ctx context.Context) (bool, error)

+ func (mc *MetricsClient) StreamAll(ctx context.Context, fn func(types.AllMetrics) error) error

+ func (mc *MetricsClient) StreamCPU(ctx context.Context, fn func([]cpu.TimesStat) error) error

+ func (mc *MetricsClient) StreamMemory(ctx context.Context, fn func(*mem.VirtualMemoryStat) error) error

+ func (mc *MetricsClient) StreamNetwork(ctx context.Context, fn func([]gopsnet.IOCountersStat) error) error

+ func (mc *MetricsClient) StreamPorts(ctx context.Context, fn func(types.PortEvent) error) error

+ func (mc *MetricsClient) StreamProcesses(ctx context.Context, fn func([]types.ProcessStat) error) error

type NodeClient

+ func (n *NodeClient) ExecJobStream(ctx context.Context, jobID string, fn func(types.JobEvent) error) error

+ func (n *NodeClient) GetConfig(ctx context.Context, integration string, config any) error

+ func (n *NodeClient) Stream(ctx context.Context, path string, fn func(Event) error) error

+ type PortEvent = types.PortEvent

+ type ProcessStat = types.ProcessStat

type SystemdClient

+ func (sc *SystemdClient) StreamJournal(ctx context.Context, unit string, lines int, fn func(types.JournalEntry) error) error

+ func (sc *SystemdClient) StreamSystemJournal(ctx context.Context, lines int, fn func(types.JournalEntry) error) error

Apr 5, 2026

Changes in this version

+ func GetConfig(n *NodeClient, ctx context.Context, integration string, config any) error

type DockerClient

+ func (dc *DockerClient) Config(ctx context.Context) (integrationsTypes.DockerConfig, error)

type FilesClient

+ func (fc *FilesClient) Config(ctx context.Context) (integrationsTypes.FilesConfig, error)

+ func (fc *FilesClient) Send(ctx context.Context, req types.SendRequest) (types.SendResult, error)

+ func (fc *FilesClient) SendDir(ctx context.Context, req types.SendDirRequest) ([]types.SendResult, error)

+ func (fc *FilesClient) Stat(ctx context.Context, path string) (types.FileStat, error)

type FleetClient

+ func (f *FleetClient) Files() *FleetFilesClient

+ type FleetFilesClient struct

+ func (ff *FleetFilesClient) Config(ctx context.Context) (map[string]integrationsTypes.FilesConfig, map[string]error)

+ func (ff *FleetFilesClient) Download(ctx context.Context, path string, localPath string) (map[string]string, map[string]error)

+ func (ff *FleetFilesClient) List(ctx context.Context, path string) (map[string][]types.DirEntry, map[string]error)

+ func (ff *FleetFilesClient) Read(ctx context.Context, path string) (map[string]string, map[string]error)

+ func (ff *FleetFilesClient) Send(ctx context.Context, req types.SendRequest) (map[string]types.SendResult, map[string]error)

+ func (ff *FleetFilesClient) SendDir(ctx context.Context, req types.SendDirRequest) (map[string][]types.SendResult, map[string]error)

+ func (ff *FleetFilesClient) Stat(ctx context.Context, path string) (map[string]types.FileStat, map[string]error)

type FleetMetricsClient

+ func (fm *FleetMetricsClient) Config(ctx context.Context) (map[string]integrationsTypes.MetricsConfig, map[string]error)

type FleetVarsClient

+ func (fv *FleetVarsClient) Config(ctx context.Context) (map[string]integrationsTypes.VarsConfig, map[string]error)

type MetricsClient

+ func (mc *MetricsClient) Config(ctx context.Context) (integrationsTypes.MetricsConfig, error)

type SystemdClient

+ func (sc *SystemdClient) Config(ctx context.Context) (integrationsTypes.SystemdConfig, error)

type VarsClient

+ func (vc *VarsClient) Config(ctx context.Context) (integrationsTypes.VarsConfig, error)

Apr 2, 2026

Changes in this version

+ var Peers map[key.NodePublic]*ipnstate.PeerStatus

Mar 31, 2026

Changes in this version

+ var TTL = 15 * time.Minute

+ func GetTailkitHostname(hostname string) string

Mar 28, 2026

Changes in this version

+ func GetPeers(ctx context.Context, srv *Server) (map[key.NodePublic]*ipnstate.PeerStatus, error)

+ type ComposeService struct

+ ConfigFiles []string

+ Name string

+ Status string

type FleetClient

+ func Nodes(srv *Server, peers []Peer) *FleetClient

+ type Peer struct

+ Status ipnstate.PeerStatus

+ Tailkit *TailkitPeer

+ func AllPeers(ctx context.Context, srv *Server) ([]Peer, error)

+ func OnlinePeers(ctx context.Context, srv *Server) ([]Peer, error)

type ServerConfig

+ Tags []string

+ type TailkitPeer struct

+ Status ipnstate.PeerStatus

+ Tools []Tool

+ func GetTailkitPeer(ctx context.Context, srv *Server, hostname string) (*TailkitPeer, error)

+ func TailkitPeers(ctx context.Context, srv *Server) ([]TailkitPeer, error)

type Tool

+ func GetPeerTools(ctx context.Context, srv *Server, tailscaleIP string) ([]Tool, error)

Mar 22, 2026

Changes in this version

type SendDirRequest

+ Filename string

type SendRequest

+ Filename string

type SendResult

+ Filename string

Mar 22, 2026

Changes in this version

type SendDirRequest

+ ToolName string

type SendRequest

+ ToolName string

type SendResult

+ ToolName string

Mar 21, 2026

Changes in this version

type SendResult

+ Error string

Mar 21, 2026

Changes in this version

type SendResult

+ DestMachine string

+ LocalPath string

+ Success bool

Mar 19, 2026

Changes in this version

+ const PatternFilename

+ const PatternIP

+ const PatternIdentifier

+ const PatternPath

+ const PatternPort

+ const PatternSemver

+ var ErrCommandNotFound = errors.New("tailkit: command not registered by tool")

+ var ErrDockerUnavailable = errors.New("tailkit: node has no docker.toml or daemon not running")

+ var ErrMetricsUnavailable = errors.New("tailkit: node has no metrics.toml")

+ var ErrPermissionDenied = errors.New("tailkit: ACL cap or node config blocked the operation")

+ var ErrReceiveNotConfigured = errors.New("tailkit: node has no files.toml (receive not configured)")

+ var ErrSystemdUnavailable = errors.New("tailkit: node has no systemd.toml or D-Bus unavailable")

+ var ErrToolNotFound = errors.New("tailkit: tool not installed on node")

+ var ErrVarScopeNotFound = errors.New("tailkit: project/env scope not in vars.toml")

+ func AuthMiddleware(srv *Server) func(http.Handler) http.Handler

+ func ExecWith(ctx context.Context, vars map[string]string, argv []string) error

+ func Install(ctx context.Context, tool Tool) error

+ func Uninstall(name string) error

+ type Arg struct

+ Name string

+ Pattern string

+ Required bool

+ Type string

+ type CallerContextKey struct

+ type CallerIdentity struct

+ Caps map[string]bool

+ Hostname string

+ TailscaleIP string

+ UserLogin string

+ func CallerFromContext(ctx context.Context) (CallerIdentity, bool)

+ func (id CallerIdentity) HasCap(cap string) bool

+ type Command struct

+ ACLCap string

+ Args []Arg

+ Description string

+ ExecParts []string

+ Name string

+ Timeout time.Duration

+ type ComposeClient struct

+ func (cc *ComposeClient) Build(ctx context.Context, name string) (Job, error)

+ func (cc *ComposeClient) Down(ctx context.Context, name string) (Job, error)

+ func (cc *ComposeClient) Project(ctx context.Context, name string) (map[string]any, error)

+ func (cc *ComposeClient) Projects(ctx context.Context) ([]map[string]any, error)

+ func (cc *ComposeClient) Pull(ctx context.Context, name string) (Job, error)

+ func (cc *ComposeClient) Restart(ctx context.Context, name string) (Job, error)

+ func (cc *ComposeClient) Up(ctx context.Context, name, composefile string) (Job, error)

+ type DirEntry struct

+ IsDir bool

+ ModTime time.Time

+ Mode string

+ Name string

+ Size int64

+ type DockerClient struct

+ func (dc *DockerClient) Available(ctx context.Context) (bool, error)

+ func (dc *DockerClient) Compose() *ComposeClient

+ func (dc *DockerClient) Container(ctx context.Context, id string) (map[string]any, error)

+ func (dc *DockerClient) Containers(ctx context.Context) ([]map[string]any, error)

+ func (dc *DockerClient) Images(ctx context.Context) ([]map[string]any, error)

+ func (dc *DockerClient) Logs(ctx context.Context, id string, tail int) (string, error)

+ func (dc *DockerClient) Pull(ctx context.Context, ref string) (Job, error)

+ func (dc *DockerClient) Remove(ctx context.Context, id string) (Job, error)

+ func (dc *DockerClient) Restart(ctx context.Context, id string) (Job, error)

+ func (dc *DockerClient) Start(ctx context.Context, id string) (Job, error)

+ func (dc *DockerClient) Stats(ctx context.Context, id string) (map[string]any, error)

+ func (dc *DockerClient) Stop(ctx context.Context, id string) (Job, error)

+ func (dc *DockerClient) Swarm() *SwarmClient

+ type FilesClient struct

+ func (fc *FilesClient) Download(ctx context.Context, remotePath, localPath string) error

+ func (fc *FilesClient) List(ctx context.Context, dirPath string) ([]DirEntry, error)

+ func (fc *FilesClient) Read(ctx context.Context, path string) (string, error)

+ type FleetClient struct

+ func AllNodes(srv *Server) *FleetClient

+ func (f *FleetClient) Metrics() *FleetMetricsClient

+ func (f *FleetClient) Vars(project, env string) *FleetVarsClient

+ type FleetMetricsClient struct

+ func (fm *FleetMetricsClient) All(ctx context.Context) (map[string]map[string]any, map[string]error)

+ func (fm *FleetMetricsClient) CPU(ctx context.Context) (map[string]map[string]any, map[string]error)

+ func (fm *FleetMetricsClient) Memory(ctx context.Context) (map[string]map[string]any, map[string]error)

+ type FleetVarsClient struct

+ func (fv *FleetVarsClient) List(ctx context.Context) (map[string]map[string]string, map[string]error)

+ func (fv *FleetVarsClient) Set(ctx context.Context, key, value string) map[string]error

+ type Job struct

+ JobID string

+ Status JobStatus

+ type JobResult struct

+ DurationMs int64

+ Error string

+ ExitCode int

+ JobID string

+ Status JobStatus

+ Stderr string

+ Stdout string

+ type JobStatus string

+ const JobStatusAccepted

+ const JobStatusCancelled

+ const JobStatusCompleted

+ const JobStatusFailed

+ const JobStatusRunning

+ type MetricsClient struct

+ func (mc *MetricsClient) All(ctx context.Context) (map[string]any, error)

+ func (mc *MetricsClient) Available(ctx context.Context) (bool, error)

+ func (mc *MetricsClient) CPU(ctx context.Context) (map[string]any, error)

+ func (mc *MetricsClient) Disk(ctx context.Context) ([]map[string]any, error)

+ func (mc *MetricsClient) Host(ctx context.Context) (map[string]any, error)

+ func (mc *MetricsClient) Memory(ctx context.Context) (map[string]any, error)

+ func (mc *MetricsClient) Network(ctx context.Context) ([]map[string]any, error)

+ func (mc *MetricsClient) Processes(ctx context.Context) ([]map[string]any, error)

+ type NodeClient struct

+ func Node(srv *Server, hostname string) *NodeClient

+ func (n *NodeClient) Docker() *DockerClient

+ func (n *NodeClient) Exec(ctx context.Context, tool, command string, args map[string]string) (Job, error)

+ func (n *NodeClient) ExecJob(ctx context.Context, jobID string) (JobResult, error)

+ func (n *NodeClient) ExecWait(ctx context.Context, tool, command string, args map[string]string) (JobResult, error)

+ func (n *NodeClient) Files() *FilesClient

+ func (n *NodeClient) HasTool(ctx context.Context, name, minVersion string) (bool, error)

+ func (n *NodeClient) Metrics() *MetricsClient

+ func (n *NodeClient) Send(ctx context.Context, req SendRequest) (SendResult, error)

+ func (n *NodeClient) SendDir(ctx context.Context, req SendDirRequest) ([]SendResult, error)

+ func (n *NodeClient) Systemd() *SystemdClient

+ func (n *NodeClient) Tools(ctx context.Context) ([]Tool, error)

+ func (n *NodeClient) Vars(project, env string) *VarsClient

+ type NodeInfo struct

+ Name string

+ TailscaleIP string

+ Tool Tool

+ func Discover(ctx context.Context, srv *Server, toolName string) ([]NodeInfo, error)

+ func DiscoverVersion(ctx context.Context, srv *Server, toolName, minVersion string) ([]NodeInfo, error)

+ type SendDirRequest struct

+ DestPath string

+ LocalDir string

+ type SendRequest struct

+ DestPath string

+ LocalPath string

+ type SendResult struct

+ BytesWritten int64

+ JobID string

+ WrittenTo string

+ func Broadcast(ctx context.Context, srv *Server, req SendRequest) ([]SendResult, map[string]error)

+ type Server struct

+ func NewServer(cfg ServerConfig) (*Server, error)

+ func (s *Server) ListenAndServe(addr string, handler http.Handler) error

+ func (s *Server) ListenAndServeTLS(addr string, handler http.Handler) error

+ func (s *Server) TLSConfig() *tls.Config

+ type ServerConfig struct

+ AuthKey string

+ Ephemeral bool

+ Hostname string

+ StateDir string

+ type SwarmClient struct

+ func (sc *SwarmClient) Nodes(ctx context.Context) ([]map[string]any, error)

+ func (sc *SwarmClient) Services(ctx context.Context) ([]map[string]any, error)

+ func (sc *SwarmClient) Tasks(ctx context.Context) ([]map[string]any, error)

+ type SystemdClient struct

+ func (sc *SystemdClient) Available(ctx context.Context) (bool, error)

+ func (sc *SystemdClient) Disable(ctx context.Context, unit string) (Job, error)

+ func (sc *SystemdClient) Enable(ctx context.Context, unit string) (Job, error)

+ func (sc *SystemdClient) Journal(ctx context.Context, unit string, lines int) ([]map[string]any, error)

+ func (sc *SystemdClient) Reload(ctx context.Context, unit string) (Job, error)

+ func (sc *SystemdClient) Restart(ctx context.Context, unit string) (Job, error)

+ func (sc *SystemdClient) Start(ctx context.Context, unit string) (Job, error)

+ func (sc *SystemdClient) Stop(ctx context.Context, unit string) (Job, error)

+ func (sc *SystemdClient) SystemJournal(ctx context.Context, lines int) ([]map[string]any, error)

+ func (sc *SystemdClient) Unit(ctx context.Context, unit string) (map[string]any, error)

+ func (sc *SystemdClient) UnitFile(ctx context.Context, unit string) (string, error)

+ func (sc *SystemdClient) Units(ctx context.Context) ([]map[string]any, error)

+ type Tool struct

+ Commands []Command

+ Name string

+ TsnetHost string

+ Version string

+ type VarsClient struct

+ func (vc *VarsClient) Delete(ctx context.Context, key string) error

+ func (vc *VarsClient) Env(ctx context.Context) (string, error)

+ func (vc *VarsClient) Get(ctx context.Context, key string) (string, error)

+ func (vc *VarsClient) List(ctx context.Context) (map[string]string, error)

+ func (vc *VarsClient) Set(ctx context.Context, key, value string) error