client

package

Go to main page

Versions in this module

v0

v0.5.4

Jul 15, 2026

v0.5.3

Jun 30, 2026

v0.5.2

Jun 28, 2026

Changes in this version

type ComposeScope

+ func (c ComposeScope) Service(name string) ComposeServicescope

+ func (c ComposeScope) Services(ctx context.Context) ([]ComposeService, error)

+ type ComposeServicescope struct

+ Backend ClientBackend

+ Hostname string

+ ServiceName string

+ func (c ComposeServicescope) Build(ctx context.Context) (Job, error)

+ func (c ComposeServicescope) Down(ctx context.Context) (Job, error)

+ func (c ComposeServicescope) Get(ctx context.Context) (ComposeService, error)

+ func (c ComposeServicescope) Pull(ctx context.Context) (Job, error)

+ func (c ComposeServicescope) Restart(ctx context.Context) (Job, error)

+ func (c ComposeServicescope) Up(ctx context.Context, composeFile string) (Job, error)

type ContainerScope

+ func (d ContainerScope) Stream(ctx context.Context, fn func(Event[DockerEvent]) error) error

type DockerScope

+ func (d DockerScope) Config(ctx context.Context) (integrations.DockerConfig, error)

type FleetVarsScope

+ Service string

type MetricsScope

+ func (m MetricsScope) All(ctx context.Context, fn func(Event[Metrics]) error) error

+ func (m MetricsScope) Ports(ctx context.Context) ([]Port, error)

+ func (m MetricsScope) Stream() MetricsStreamScope

+ type MetricsStreamScope struct

+ Backend ClientBackend

+ Hostname string

+ func (m MetricsStreamScope) CPU(ctx context.Context, fn func(Event[CPU]) error) error

+ func (m MetricsStreamScope) Memory(ctx context.Context, fn func(Event[Memory]) error) error

+ func (m MetricsStreamScope) Ports(ctx context.Context, fn func(Event[PortUpdate]) error) error

type ServicesScope

+ func (s ServicesScope) Ports(ctx context.Context) ([]Port, error)

type SwarmScope

+ func (s SwarmScope) Services() SwarmServicesNamespace

+ func (s SwarmScope) Stream() SwarmStreamScope

+ type SwarmServicesNamespace struct

+ Backend ClientBackend

+ Hostname string

+ func (s SwarmServicesNamespace) List(ctx context.Context) ([]SwarwService, error)

+ type SwarmStreamScope struct

+ Backend ClientBackend

+ Hostname string

+ ID string

+ type SwarmUpdate struct

+ Servies []swarm.Service

+ SwarmID []string

+ type SwarwService = swarm.Service

type SystemdScope

+ func (s SystemdScope) Stream() SystemdStreamScope

+ type SystemdStreamScope struct

+ Backend ClientBackend

+ Hostname string

+ func (s SystemdStreamScope) System(ctx context.Context, lines int, fn func(Event[JournalEntry]) error) error

type UnitScope

+ func (u UnitScope) Stream() UnitStreamScope

+ type UnitStreamScope struct

+ Backend ClientBackend

+ Hostname string

+ UnitName string

+ func (u UnitStreamScope) Journal(ctx context.Context, lines int, fn func(Event[JournalEntry]) error) error

type VarsScope

+ Service string

v0.5.1

Jun 27, 2026

Changes in this version

+ const EventAll

+ const EventCPU

+ const EventDockerAll

+ const EventDockerContainer

+ const EventError

+ 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

+ const PatternFilename

+ const PatternIP

+ const PatternIdentifier

+ const PatternPath

+ const PatternPort

+ const PatternSemver

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

+ var ErrConflict = errors.New("tailkit: conflict")

+ 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 ErrUnauthorized = errors.New("tailkit: unauthorized")

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

+ func FanOut[T any](ctx context.Context, hostnames []string, ...) (map[string]T, map[string]error)

+ func StreamEvents[T any](ctx context.Context, body io.ReadCloser, allowedEvents []string, ...) error

+ type AgentListOptions struct

+ Online bool

+ type AgentScope struct

+ Backend ClientBackend

+ Hostname string

+ func (a AgentScope) Events() EventsScope

+ func (a AgentScope) Execute(ctx context.Context, cmd string, args []string) ([]byte, error)

+ func (a AgentScope) Get(ctx context.Context) (Tailkitd, error)

+ func (a AgentScope) Logs() LogsScope

+ func (a AgentScope) Restart(ctx context.Context) error

+ func (a AgentScope) Services() AgentServicesScope

+ func (a AgentScope) Update(ctx context.Context, version string) error

+ type AgentServicesScope struct

+ Backend ClientBackend

+ Hostname string

+ func (s AgentServicesScope) List(ctx context.Context, opts ...ServiceListOptions) ([]Service, error)

+ type AgentsScope struct

+ Backend ClientBackend

+ Hostnames []string

+ func (h AgentsScope) List(ctx context.Context, opts ...AgentListOptions) (map[string]Tailkitd, map[string]error)

+ type Arg struct

+ Name string

+ Pattern string

+ Required bool

+ Type string

+ type CPU struct

+ Info []gopsutilcpu.InfoStat

+ Percent []float64

+ Total float64

+ type ClientBackend interface

+ Agents func(ctx context.Context, opts *AgentListOptions) ([]string, error)

+ Do func(ctx context.Context, hostname, method, path string, body io.Reader, out any) error

+ DoRaw func(ctx context.Context, hostname, method, path string, body io.Reader, ...) ([]byte, error)

+ Hosts func(ctx context.Context, opts *HostListOptions) ([]string, error)

+ Peers func(ctx context.Context, opts *PeerListOptions) ([]string, error)

+ Stream func(ctx context.Context, hostname, method, path string) (io.ReadCloser, error)

+ type ComposeProjectScope struct

+ Backend ClientBackend

+ Hostname string

+ ProjectName string

+ func (c ComposeProjectScope) Build(ctx context.Context) (Job, error)

+ func (c ComposeProjectScope) Down(ctx context.Context) (Job, error)

+ func (c ComposeProjectScope) Get(ctx context.Context) (ComposeService, error)

+ func (c ComposeProjectScope) Pull(ctx context.Context) (Job, error)

+ func (c ComposeProjectScope) Restart(ctx context.Context) (Job, error)

+ func (c ComposeProjectScope) Up(ctx context.Context, composeFile string) (Job, error)

+ type ComposeScope struct

+ Backend ClientBackend

+ Hostname string

+ func (c ComposeScope) Project(name string) ComposeProjectScope

+ func (c ComposeScope) Projects(ctx context.Context) ([]ComposeService, error)

+ type ComposeService struct

+ ConfigFiles []string

+ Name string

+ Status string

+ type Container = container.Summary

+ type ContainerScope struct

+ Backend ClientBackend

+ ContainerID string

+ Hostname string

+ func (c ContainerScope) Inspect(ctx context.Context) (container.InspectResponse, error)

+ func (c ContainerScope) Logs(ctx context.Context, tailLines int) (io.ReadCloser, error)

+ func (c ContainerScope) Remove(ctx context.Context) error

+ func (c ContainerScope) Restart(ctx context.Context) error

+ func (c ContainerScope) Start(ctx context.Context) error

+ func (c ContainerScope) Stop(ctx context.Context) error

+ func (c ContainerScope) StreamLogs(ctx context.Context, tail int, fn func(Event[LogLine]) error) error

+ func (c ContainerScope) StreamStats(ctx context.Context, fn func(Event[container.StatsResponse]) error) error

+ type ContainersNamespace struct

+ Backend ClientBackend

+ Hostname string

+ func (c ContainersNamespace) List(ctx context.Context) ([]Container, error)

+ type DirEntry struct

+ IsDir bool

+ ModTime time.Time

+ Mode string

+ Name string

+ Size int64

+ type DirScope struct

+ Backend ClientBackend

+ Hostname string

+ Path string

+ func (d DirScope) List(ctx context.Context) ([]DirEntry, error)

+ func (d DirScope) Send(ctx context.Context, req SendDirRequest) ([]SendResult, error)

+ type Disk = *gopsutildisk.UsageStat

+ type DockerEvent = events.Message

+ type DockerScope struct

+ Backend ClientBackend

+ Hostname string

+ func (d DockerScope) Compose() ComposeScope

+ func (d DockerScope) Container(id string) ContainerScope

+ func (d DockerScope) Containers() ContainersNamespace

+ func (d DockerScope) Images() ImagesNamespace

+ func (d DockerScope) Stream(ctx context.Context, fn func(Event[DockerEvent]) error) error

+ func (d DockerScope) Swarm() SwarmScope

+ type Event struct

+ Data T

+ ID int64

+ Name string

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

+ type EventsScope struct

+ Backend ClientBackend

+ Hostname string

+ func (e EventsScope) Stream(ctx context.Context) (io.ReadCloser, error)

+ type FileScope struct

+ Backend ClientBackend

+ Hostname string

+ Path string

+ func (f FileScope) Config(ctx context.Context) (integrations.FilesConfig, error)

+ func (f FileScope) Delete(ctx context.Context) error

+ func (f FileScope) Download(ctx context.Context, localDestPath string) error

+ func (f FileScope) Read(ctx context.Context) (io.ReadCloser, error)

+ func (f FileScope) Send(ctx context.Context, req SendRequest) (SendResult, error)

+ func (f FileScope) Stat(ctx context.Context) (FileStat, error)

+ func (f FileScope) Write(ctx context.Context, content io.Reader) error

+ type FileStat struct

+ SHA256 string

+ type FilesScope struct

+ Backend ClientBackend

+ Hostname string

+ func (f FilesScope) Dir(path string) DirScope

+ func (f FilesScope) File(path string) FileScope

+ type FleetFilesScope struct

+ Backend ClientBackend

+ Hostnames []string

+ func (ff FleetFilesScope) Config(ctx context.Context) (map[string]integrations.FilesConfig, map[string]error)

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

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

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

+ type FleetMetricsScope struct

+ Backend ClientBackend

+ Hostnames []string

+ func (fm FleetMetricsScope) All(ctx context.Context) (map[string]Metrics, map[string]error)

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

+ func (fm FleetMetricsScope) Config(ctx context.Context) (map[string]integrations.MetricsConfig, map[string]error)

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

+ type FleetVarsScope struct

+ Backend ClientBackend

+ Env string

+ Hostnames []string

+ Project string

+ func (fv FleetVarsScope) Config(ctx context.Context) (map[string]integrations.VarsConfig, map[string]error)

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

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

+ type Host struct

+ Arch string

+ Environment string

+ InstanceType string

+ IsAdmin bool

+ Metadata map[string]string

+ Name string

+ OS string

+ Online bool

+ Peer *Peer

+ Provider string

+ Role string

+ TSDNSName string

+ TSHostname string

+ TSIPs []string

+ Tags []string

+ Tailkitd *Tailkitd

+ func (h *Host) IsClassified() bool

+ type HostListOptions struct

+ Environment string

+ Online bool

+ Tags []string

+ type HostScope struct

+ Backend ClientBackend

+ Hostname string

+ func (h HostScope) Agent() AgentScope

+ func (h HostScope) Docker() DockerScope

+ func (h HostScope) Files() FilesScope

+ func (h HostScope) Get(ctx context.Context) (Host, error)

+ func (h HostScope) Metrics() MetricsScope

+ func (h HostScope) Systemd() SystemdScope

+ func (h HostScope) Vars(project, env string) VarsScope

+ type HostsScope struct

+ Backend ClientBackend

+ Hostnames []string

+ func (h HostsScope) Files() FleetFilesScope

+ func (h HostsScope) List(ctx context.Context, opts ...HostListOptions) (map[string]Host, map[string]error)

+ func (h HostsScope) Metrics() FleetMetricsScope

+ func (h HostsScope) Vars(project, env string) FleetVarsScope

+ type Image = image.Summary

+ type ImagesNamespace struct

+ Backend ClientBackend

+ Hostname string

+ func (i ImagesNamespace) List(ctx context.Context) ([]Image, error)

+ func (i ImagesNamespace) Pull(ctx context.Context, ref string) (Image, error)

+ func (i ImagesNamespace) Push(ctx context.Context, ref string) (Image, 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 JobUpdate struct

+ Error string

+ Event string

+ ExitCode int

+ JobID string

+ Line string

+ Status JobStatus

+ Stream string

+ type JournalEntry struct

+ Fields map[string]string

+ Message string

+ Priority string

+ Timestamp uint64

+ Unit string

+ type LogLine struct

+ ContainerID string

+ Line string

+ Stream string

+ TS time.Time

+ type LogsScope struct

+ Backend ClientBackend

+ Hostname string

+ func (l LogsScope) Stream(ctx context.Context) (io.ReadCloser, error)

+ type Memory struct

+ Swap *gopsutilmem.SwapMemoryStat

+ Virtual *gopsutilmem.VirtualMemoryStat

+ type Metrics struct

+ CPU *CPU

+ Disk []*gopsutildisk.UsageStat

+ Host *gopsutilhost.InfoStat

+ Memory *Memory

+ Network []gopsutilnet.IOCountersStat

+ Ports []Port

+ Processes []Process

+ type MetricsScope struct

+ Backend ClientBackend

+ Hostname string

+ func (m MetricsScope) CPU(ctx context.Context) (CPU, error)

+ func (m MetricsScope) Disk(ctx context.Context) ([]Disk, error)

+ func (m MetricsScope) Memory(ctx context.Context) (Memory, error)

+ func (m MetricsScope) Network(ctx context.Context) ([]Network, error)

+ func (m MetricsScope) Processes(ctx context.Context) ([]Process, error)

+ func (m MetricsScope) StreamAll(ctx context.Context, fn func(Event[Metrics]) error) error

+ func (m MetricsScope) StreamCPU(ctx context.Context, fn func(Event[CPU]) error) error

+ func (m MetricsScope) StreamMemory(ctx context.Context, fn func(Event[Memory]) error) error

+ type Network = gopsutilnet.IOCountersStat

+ type Peer struct

+ DNSName string

+ HostName string

+ ID string

+ IPs []string

+ Metadata map[string]string

+ OS string

+ Online bool

+ PublicKey string

+ Status *ipnstate.PeerStatus

+ type PeerListOptions struct

+ Online bool

+ type PeerScope struct

+ Backend ClientBackend

+ Hostname string

+ func (p PeerScope) Get(ctx context.Context) (*Peer, error)

+ func (p PeerScope) Host() HostScope

+ type PeersScope struct

+ Backend ClientBackend

+ Hostnames []string

+ func (h PeersScope) List(ctx context.Context, opt PeerListOptions) (map[string]Peer, map[string]error)

+ type Port struct

+ Addr string

+ PID int

+ Port uint16

+ Process string

+ Proto string

+ type PortUpdate struct

+ Kind string

+ Port Port

+ Ports []Port

+ type Process struct

+ CPUPercent float64

+ Cmdline string

+ MemoryRSS uint64

+ Name string

+ PID int32

+ Status string

+ type RawEvent struct

+ Data json.RawMessage

+ ID int64

+ Name string

+ type SendDirRequest struct

+ DestPath string

+ Filename string

+ LocalDir string

+ ToolName string

+ type SendRequest struct

+ DestPath string

+ Filename string

+ LocalPath string

+ ToolName string

+ type SendResult struct

+ BytesWritten int64

+ DestMachine string

+ Error string

+ Filename string

+ LocalPath string

+ Success bool

+ ToolName string

+ WrittenTo string

+ type Service struct

+ Addresses []string

+ BinaryPath string

+ Capabilities ServiceCapabilities

+ ContainerID string

+ Description string

+ ExpectedPorts []uint16

+ HostName string

+ ID string

+ Kind string

+ Name string

+ NodeName string

+ PidFile string

+ Ports []uint16

+ Priority string

+ Runtime string

+ Source string

+ Status ServiceStatus

+ SystemdUnit string

+ Tags []string

+ Version string

+ func (s *Service) Normalize()

+ type ServiceCapabilities struct

+ Logs bool

+ Reload bool

+ Restart bool

+ Start bool

+ Status bool

+ Stop bool

+ type ServiceListOptions struct

+ Kind string

+ Runtime string

+ type ServiceScope struct

+ Backend ClientBackend

+ ServiceID string

+ func (s ServiceScope) Get(ctx context.Context) (Service, error)

+ func (s ServiceScope) Host() HostScope

+ func (s ServiceScope) Logs(ctx context.Context, tailLines int) (io.ReadCloser, error)

+ func (s ServiceScope) Reload(ctx context.Context) error

+ func (s ServiceScope) Restart(ctx context.Context) error

+ func (s ServiceScope) Start(ctx context.Context) error

+ func (s ServiceScope) Stop(ctx context.Context) error

+ type ServiceStatus struct

+ Health string

+ Message string

+ PID int

+ StartedAt *time.Time

+ State string

+ UpdatedAt *time.Time

+ type ServicesScope struct

+ Backend ClientBackend

+ TargetIDs []string

+ func (s ServicesScope) List(ctx context.Context, opts ...AgentListOptions) (map[string][]Service, map[string]error)

+ type SwarmScope struct

+ Backend ClientBackend

+ Hostname string

+ func (s SwarmScope) Join(ctx context.Context, tokens []string) error

+ func (s SwarmScope) Leave(ctx context.Context) error

+ func (s SwarmScope) Status(ctx context.Context) (SwarmStatus, error)

+ type SwarmStatus = swarm.Swarm

+ type SystemdScope struct

+ Backend ClientBackend

+ Hostname string

+ func (s SystemdScope) StreamSystemJournal(ctx context.Context, lines int, fn func(Event[JournalEntry]) error) error

+ func (s SystemdScope) SystemJournal(ctx context.Context, lines int) ([]JournalEntry, error)

+ func (s SystemdScope) Unit(name string) UnitScope

+ func (s SystemdScope) Units() UnitsNamespace

+ type SystemdUnit = dbus.UnitStatus

+ type Tailkitd struct

+ HostName string

+ Peer *Peer

+ Services []Service

+ type TailnetClient interface

+ Agent func(hostname string) AgentScope

+ Agents func(hostnames ...string) AgentsScope

+ Host func(hostname string) HostScope

+ Hosts func(hostnames ...string) HostsScope

+ Peer func(hostname string) PeerScope

+ Peers func(hostnames ...string) PeersScope

+ Service func(serviceID string) ServiceScope

+ Services func(serviceIDs ...string) ServicesScope

+ type Tool struct

+ Name string

+ TsnetHost string

+ Version string

+ type UnitScope struct

+ Backend ClientBackend

+ Hostname string

+ UnitName string

+ func (u UnitScope) Disable(ctx context.Context) error

+ func (u UnitScope) Enable(ctx context.Context) error

+ func (u UnitScope) File(ctx context.Context) (string, error)

+ func (u UnitScope) Get(ctx context.Context) (map[string]any, error)

+ func (u UnitScope) Journal(ctx context.Context, lines int) ([]JournalEntry, error)

+ func (u UnitScope) Reload(ctx context.Context) error

+ func (u UnitScope) Restart(ctx context.Context) error

+ func (u UnitScope) Start(ctx context.Context) error

+ func (u UnitScope) Status(ctx context.Context) (SystemdUnit, error)

+ func (u UnitScope) Stop(ctx context.Context) error

+ func (u UnitScope) StreamJournal(ctx context.Context, lines int, fn func(Event[JournalEntry]) error) error

+ type UnitsNamespace struct

+ Backend ClientBackend

+ Hostname string

+ func (u UnitsNamespace) List(ctx context.Context) ([]SystemdUnit, error)

+ type VarsScope struct

+ Backend ClientBackend

+ Env string

+ Hostname string

+ Project string

+ func (v VarsScope) Delete(ctx context.Context, key string) error

+ func (v VarsScope) Get(ctx context.Context, key string) (string, error)

+ func (v VarsScope) List(ctx context.Context) (map[string]string, error)

+ func (v VarsScope) Set(ctx context.Context, key, value string) error

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