core

package

Go to main page

Versions in this module

v0

v0.12.3

Aug 11, 2026

v0.12.0

Aug 11, 2026

Changes in this version

+ func EstimateUploadBytes(jobs []TransferJob, opts TransferOptions) (int64, error)

type TransferOptions

+ Progress func(int64)

+ StartProgress func(int64) bool

v0.11.0

Jul 10, 2026

Changes in this version

+ func ExpandUserPath(filePath string) string

type AuthProfile

+ KeyData string

+ KeyDataEnc string

+ KeyPassphrase string

+ KeyPassphraseEnc string

type Host

+ KeyData string

+ KeyDataEnc string

+ KeyPassphrase string

+ KeyPassphraseEnc string

v0.10.0

Jul 8, 2026

Changes in this version

+ const CheckStatusFail

+ const CheckStatusOK

+ const CheckStatusSkipped

+ func AppendBatchRunLog(record BatchRunRecord) error

+ func BatchLogPath(when time.Time) (string, error)

+ func FailedBatchRunHosts(record BatchRunRecord) []string

+ func HasMaskedRunEnv(env map[string]string) bool

+ func HostHasTags(host Host, tags []string) bool

+ func HostTagsLabel(host Host) string

+ func IsSensitiveEnvName(name string) bool

+ func MaskRunEnv(env map[string]string) map[string]string

+ func NewBatchID(startedAt time.Time) string

+ func NormalizeGroupDefaults(group *GroupDefaults)

+ func NormalizeTagList(tags []string) []string

+ func NormalizeTags(value string) []string

+ func ParseSSHConfigImport(reader io.Reader, opts SSHConfigImportOptions) ([]Host, []SSHConfigImportWarning, []HostImportError)

+ func SSHConfigPathForImport() (string, error)

+ type BatchRunOptions struct

+ CWD string

+ Env map[string]string

+ EnvFile string

+ KeepRemoteScript bool

+ KillAfter string

+ RemoteScriptDir string

+ ScriptPath string

+ Sudo bool

+ SudoUser string

+ Timeout string

+ type BatchRunRecord struct

+ BatchID string

+ Command string

+ EndedAt string

+ FailedCount int

+ Hosts []string

+ Options BatchRunOptions

+ RerunOf string

+ Results []BatchRunResult

+ Script string

+ SkippedCount int

+ Source BatchRunSourceLog

+ StartedAt string

+ SuccessCount int

+ TaskName string

+ func ReadBatchRunByID(batchID string) (BatchRunRecord, bool, error)

+ type BatchRunResult struct

+ DurationMS int64

+ Error string

+ Host string

+ Status string

+ TaskID string

+ type BatchRunSourceLog struct

+ AllowRaw bool

+ AuthRef string

+ KeyPath string

+ Kind string

+ Port int

+ User string

+ Value string

+ type CheckOptions struct

+ Timeout time.Duration

+ type CheckResult struct

+ Address string

+ Auth string

+ Backend string

+ CommandProxy bool

+ Error string

+ Group string

+ HostKey string

+ LatencyMS int64

+ Name string

+ SSH string

+ TCP string

+ Tags []string

+ Via string

+ func CheckHost(host Host, opts CheckOptions) CheckResult

type Config

+ Groups map[string]GroupDefaults

+ func (c Config) GroupDefaultsForHost(host Host) (GroupDefaults, bool)

+ type GroupDefaults struct

+ AuthRef string

+ ConnectTimeout string

+ HostKeyCheck string

+ Jump string

+ KeyPath string

+ KnownHostsPath string

+ Port int

+ RemoteScriptDir string

+ RunTimeout string

+ User string

type Host

+ Tags []string

type HostImportDefaults

+ Tags []string

type ImportResult

+ GroupsAdded int

+ GroupsUpdated int

+ type SSHConfigImportOptions struct

+ Defaults HostImportDefaults

+ ImportIdentityFile bool

+ type SSHConfigImportWarning struct

+ Host string

+ Line int

+ Message string

+ func (w SSHConfigImportWarning) String() string

v0.9.0

Jul 8, 2026

Changes in this version

+ const ConfigDirEnvKey

+ func ConfigPathSource() string

+ func LogsDir() (string, error)

+ func RuntimeCommandName(args []string) string

+ func RuntimeDurationMS(start time.Time) int64

+ func RuntimeLogArgs(args []string) []string

+ func RuntimeLogPath() (string, error)

+ type HostKeyTrustOptions struct

+ Force bool

type HostKeyTrustResult

+ func TrustHostKeyWithOptions(host Host, opts HostKeyTrustOptions) (HostKeyTrustResult, error)

+ type RuntimeLogger struct

+ func InitRuntimeLogger() (*RuntimeLogger, error)

+ func (l *RuntimeLogger) Close() error

+ type WebPTY interface

+ Close func() error

+ Resize func(cols, rows int) error

+ Wait func() error

+ func OpenWebPTY(host Host, opts WebPTYOptions) (WebPTY, error)

+ type WebPTYOptions struct

+ Cols int

+ Rows int

+ Term string

v0.8.0

Jul 7, 2026

Changes in this version

+ const CommandProxyCmdToken

+ const HostBackendCommandProxy

+ const HostBackendSSH

+ func BuildRemoteRunCommand(command string, opts RunOptions) (string, error)

+ func ExecuteCommandProxy(host Host, command string, opts RunOptions) ([]byte, error)

+ func HostBackend(host Host) string

+ func IsCommandProxyHost(host Host) bool

+ func LoginCommandProxy(host Host, opts LoginOptions) error

+ func NormalizeHostFields(host *Host)

+ func ParseHostKV(text string, defaults HostImportDefaults) (Host, []HostImportError)

+ func RejectCommandProxyTransfer(host Host) error

+ func RenderCommandProxyRun(template, finalCommand string) (string, error)

+ func ValidateCommandProxyTemplate(host Host) error

+ type CommandProxyLoginPlan struct

+ LoginCommand string

+ Via Host

+ func PlanCommandProxyLogin(host Host) (CommandProxyLoginPlan, error)

+ type CommandProxyRunPlan struct

+ ProxiedCommand string

+ Via Host

+ func PlanCommandProxyRun(host Host, command string, opts RunOptions) (CommandProxyRunPlan, error)

type Host

+ Backend string

+ LoginCommand string

+ RunTemplate string

+ Via string

type HostImportDefaults

+ Backend string

+ LoginCommand string

+ RunTemplate string

+ Via string

+ type HostKeyTrustResult struct

+ Address string

+ Fingerprint string

+ Host Host

+ KeyType string

+ KnownHostsPath string

+ Status string

+ func TrustHostKey(host Host) (HostKeyTrustResult, error)

type RunLogRecord

+ Backend string

+ ProxiedCommand string

+ Via string

+ type UnknownHostKey struct

+ Hostname string

+ Key ssh.PublicKey

+ KnownHostsPath string

+ Remote net.Addr

v0.7.0

Jul 5, 2026

Changes in this version

+ const ConfigExportApp

+ const ConfigExportVersion

+ func ApplyHostImport(config *Config, plan HostImportPlan) error

+ func BackupConfigFile(now time.Time) (string, error)

+ func EncryptConfigExport(config Config, key string, now time.Time) ([]byte, error)

+ func GenerateExportKey() (string, error)

+ func MergeImportedConfig(current, imported Config, strategy ImportStrategy) (Config, ImportResult, error)

+ func ParseHostImport(reader io.Reader, format HostImportFormat, defaults HostImportDefaults) ([]Host, []HostImportError)

+ func ParseHostImportCSV(reader io.Reader, defaults HostImportDefaults) ([]Host, []HostImportError)

+ func ParseHostImportIPs(reader io.Reader, defaults HostImportDefaults) ([]Host, []HostImportError)

+ func ParseHostImportPlain(reader io.Reader, defaults HostImportDefaults) ([]Host, []HostImportError)

type Config

+ func DecryptConfigExport(data []byte, key string) (Config, error)

+ type ConfigExportFile struct

+ Cipher string

+ CreatedAt string

+ KDF string

+ Nonce string

+ Payload string

+ Version int

+ type ConfigExportPayload struct

+ App string

+ Config Config

+ ConfigVersion int

+ ExportedAt string

+ Version int

+ type HostImportAction string

+ const HostImportActionAdd

+ const HostImportActionSkip

+ const HostImportActionUpdate

+ type HostImportChange struct

+ Action HostImportAction

+ ExistingIndex int

+ Host Host

+ Reason string

+ type HostImportConflict struct

+ Field string

+ Host Host

+ Reason string

+ Value string

+ type HostImportDefaults struct

+ AuthRef string

+ ConnectTimeout string

+ Group string

+ HostKeyCheck string

+ Jump string

+ KeyPath string

+ KnownHostsPath string

+ Port int

+ Remark string

+ RemoteScriptDir string

+ RunTimeout string

+ User string

+ type HostImportError struct

+ Field string

+ Line int

+ Message string

+ func (e HostImportError) Error() string

+ type HostImportFormat string

+ const HostImportCSV

+ const HostImportIPs

+ const HostImportPlain

+ type HostImportOptions struct

+ Defaults HostImportDefaults

+ Format HostImportFormat

+ Overwrite bool

+ SkipExisting bool

+ type HostImportPlan struct

+ Added int

+ Changes []HostImportChange

+ Conflicts []HostImportConflict

+ Hosts []Host

+ Invalid []HostImportError

+ Skipped int

+ Updated int

+ func PlanHostImport(config Config, hosts []Host, opts HostImportOptions) (HostImportPlan, error)

+ type ImportResult struct

+ AuthAdded int

+ AuthUpdated int

+ BackupPath string

+ HostsAdded int

+ HostsUpdated int

+ type ImportStrategy string

+ const ImportMerge

+ const ImportOverwrite

+ const ImportReplace

v0.6.0

Jul 4, 2026

Changes in this version

+ const ConfigVersion

+ const DefaultConnectTimeout

+ const DefaultKnownHostsPath

+ const DefaultRemoteScriptDir

+ const DoctorError

+ const DoctorOK

+ const DoctorWarn

+ const HostKeyCheckInsecure

+ const HostKeyCheckKnownHosts

+ const MaskedSecret

+ func AuthLabel(host Host) string

+ func HasDoctorErrors(issues []DoctorIssue) bool

+ func NewRunTaskID(startedAt time.Time, host Host, rec RunLogRecord) string

+ func ParseLogLineRange(spec string) (start int, end int, ok bool, err error)

+ func ReadConfigFile() (string, []byte, error)

+ func ReadHostsFile(path string) ([]string, error)

+ func ReadRunLogOutputByID(target, taskID string) ([]byte, error)

+ func ReadRunLogsSelected(target, match string, tail int, rangeSpec string) ([]string, error)

+ func RunOutputPath(taskID string, startedAt time.Time) (string, string, error)

+ func SaveConfig(config *Config) error

+ func SelectLogLines(lines []string, rangeSpec string, tail int) ([]string, error)

+ type AuthProfile struct

+ KeyPath string

+ Name string

+ Password string

+ PasswordEnc string

+ Remark string

+ User string

+ func MaskAuthProfile(profile AuthProfile) AuthProfile

+ type BatchHostSource struct

+ AllowRaw bool

+ AuthRef string

+ Group string

+ Hosts []string

+ HostsFile string

+ Overrides HostOverrides

+ type Config struct

+ AuthProfiles []AuthProfile

+ Defaults Defaults

+ Hosts []Host

+ LogsPath string

+ Version int

+ func LoadConfig() (*Config, error)

+ func LoadConfigWithSSHConfig() (*Config, error)

+ func MaskConfig(config Config) Config

+ func (c Config) EffectiveHost(host Host, overrides HostOverrides) (EffectiveHost, bool, error)

+ func (c Config) FindAuthProfile(name string) (AuthProfile, bool)

+ func (c Config) ResolveConnection(host Host) (ResolvedConnection, error)

+ func (c Config) ResolveEffectiveHost(target string, overrides HostOverrides) (EffectiveHost, bool, error)

+ type Defaults struct

+ ConnectTimeout string

+ HostKeyCheck string

+ KnownHostsPath string

+ Port int

+ RemoteScriptDir string

+ RunTimeout string

+ User string

+ type DoctorIssue struct

+ Item string

+ Level string

+ Message string

+ func CheckConfig(config Config) []DoctorIssue

+ type EffectiveHost struct

+ ConnectTimeout string

+ HostKeyCheck string

+ KnownHostsPath string

+ RemoteScriptDir string

+ RunTimeout string

+ func (h EffectiveHost) ToHost() Host

type Host

+ AuthRef string

+ ConnectTimeout string

+ HostKeyCheck string

+ Jump string

+ KnownHostsPath string

+ RemoteScriptDir string

+ RunTimeout string

+ func MaskHost(host Host) Host

+ func ResolveBatchHosts(source BatchHostSource) ([]Host, error)

+ func ResolveHostWithSSHConfig(target string, overrides HostOverrides) (Host, bool, error)

+ type HostOverrides struct

+ ConnectTimeout string

+ HostKeyCheck string

+ KeyPath string

+ KnownHostsPath string

+ Password string

+ Port int

+ RemoteScriptDir string

+ RunTimeout string

+ User string

+ type RemoteClient interface

+ Close func() error

+ NewSession func() (*ssh.Session, error)

+ NewSftp func(...sftp.ClientOption) (*sftp.Client, error)

+ Run func(string) ([]byte, error)

+ RunContext func(context.Context, string) ([]byte, error)

+ type ResolveConnectionOptions struct

+ Jump string

+ type ResolvedConnection struct

+ Jump *Host

+ Target Host

+ func ResolveConnectionForHost(host Host) (ResolvedConnection, error)

+ func ResolveConnectionWithSSHConfig(target string, opts ResolveConnectionOptions) (ResolvedConnection, bool, error)

type RunLogRecord

+ OutputBytes int64

+ OutputFile string

+ OutputInline bool

+ OutputPreview string

+ OutputSHA256 string

+ TaskID string

v0.5.0

Jul 4, 2026

Changes in this version

+ const ConfigFileName

+ const LegacyConfigFileName

+ func DecryptPassword(value string) (string, error)

+ func EncryptPassword(password string) (string, error)

+ func LegacyStorePath() (string, error)

+ func PasswordKeyPath() (string, error)

type Host

+ PasswordEnc string

type Store

+ LogsPath string

+ func LoadConfigSettings() (Store, error)

v0.4.0

Jul 3, 2026

Changes in this version

+ const ConfigEnvKey

+ const DefaultGroup

+ const DefaultSSHPort

+ func AppendRunLog(host Host, rec RunLogRecord) error

+ func BuildRemoteCommand(command string, env map[string]string) (string, error)

+ func BuildRemoteCommandWithCWD(command string, env map[string]string, cwd string) (string, error)

+ func ErrorString(err error) string

+ func ExecuteRemote(host Host, command string, opts RunOptions) ([]byte, error)

+ func HostGroupName(host Host) string

+ func HostLogName(host Host) string

+ func JoinRemotePath(base, elem string) string

+ func LoadRunEnv(file string, inline []string) (map[string]string, error)

+ func LocalDirPath(remotePath, localPath string) string

+ func LocalFilePath(remotePath, localPath string) string

+ func LoginRemote(host Host) error

+ func LoginRemoteWithOptions(host Host, opts LoginOptions) error

+ func NewRemoteScriptPath(value time.Time) string

+ func NewRemoteScriptPathInDir(value time.Time, dir string) string

+ func Now() time.Time

+ func ParseTimeout(value string) (time.Duration, error)

+ func ReadRunLogs(target, match string, tail int) ([]string, error)

+ func RemoteFilePath(localPath, remotePath string) string

+ func RemoteRelPath(root, current string) string

+ func RunStatus(err error) string

+ func SaveStore(store *Store) error

+ func SetNowForTest(fn func() time.Time) func()

+ func SetUserHomeDirForTest(fn func() (string, error)) func()

+ func SinceMS(start time.Time) int64

+ func StorePath() (string, error)

+ func ValidateSudoUser(user string) error

+ type Host struct

+ Group string

+ IP string

+ KeyPath string

+ Name string

+ Password string

+ Port int

+ Remark string

+ User string

+ func LoadSSHConfigHosts() ([]Host, error)

+ func ParseSSHConfig(reader io.Reader) ([]Host, error)

+ type LoginOptions struct

+ Stderr io.Writer

+ Stdin *os.File

+ Stdout io.Writer

+ Term string

+ type RunLogRecord struct

+ CWD string

+ Command string

+ DurationMS int64

+ Error string

+ KeepRemoteScript bool

+ Output string

+ RemoteScript string

+ Script string

+ StartedAt time.Time

+ Status string

+ Target string

+ type RunOptions struct

+ CWD string

+ Env map[string]string

+ KeepRemoteScript bool

+ KillAfter time.Duration

+ RemoteScriptDir string

+ RemoteScriptPath string

+ ScriptPath string

+ Sudo bool

+ SudoUser string

+ Timeout time.Duration

+ type Store struct

+ Hosts []Host

+ func LoadStore() (*Store, error)

+ func LoadStoreWithSSHConfig() (*Store, error)

+ func (s *Store) Upsert(host Host) error

+ func (s Store) Find(target string) (Host, bool)

+ func (s Store) MatchHosts(target string) []Host

+ func (s Store) ResolveHost(target string) (Host, bool, error)

+ type TransferJob struct

+ LocalPath string

+ RemoteDir bool

+ RemotePath string

+ type TransferOptions struct

+ RemoveDir bool

+ SHA256 bool

+ type TransferResult struct

+ Bytes int64

+ Directories int

+ Elapsed time.Duration

+ Files int

+ LocalSHA256 string

+ RemoteSHA256 string

+ SHA256OK bool

+ func FetchRemote(host Host, remotePath, localPath string, opts TransferOptions) (result TransferResult, err error)

+ func UploadRemote(host Host, localPath, remotePath string, opts TransferOptions) (result TransferResult, err error)

+ func UploadRemoteBatch(host Host, jobs []TransferJob, opts TransferOptions) (result TransferResult, err error)

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