wavebase

Documentation

Index

• Constants
• Variables
• func CacheAndRemoveEnvVars() error
• func CacheEnsureDir(dirName string, cacheKey string, perm os.FileMode, dirDesc string) error
• func ClientArch() string
• func DetermineLang() string
• func DetermineLocale() string
• func EnsureWaveConfigDir() error
• func EnsureWaveDBDir() error
• func EnsureWaveDataDir() error
• func EnsureWavePresetsDir() error
• func ExpandHomeDir(pathStr string) (string, error)
• func ExpandHomeDirSafe(pathStr string) string
• func GetDomainSocketName() string
• func GetHomeDir() string
• func GetWaveAppBinPath() string
• func GetWaveAppPath() string
• func GetWaveConfigDir() string
• func GetWaveDataDir() string
• func IsDevMode() bool
• func ReplaceHomeDir(pathStr string) string
• func TryMkdirs(dirName string, perm os.FileMode, dirDesc string) error
• func UnameKernelRelease() string
• func ValidateWshSupportedArch(os string, arch string) error
• type FDLock
  • func AcquireWaveLock() (FDLock, error)

Constants

const (
	WaveConfigHomeEnvVar      = "WAVETERM_CONFIG_HOME"
	WaveDataHomeEnvVar        = "WAVETERM_DATA_HOME"
	WaveAppPathVarName        = "WAVETERM_APP_PATH"
	WaveDevVarName            = "WAVETERM_DEV"
	WaveDevViteVarName        = "WAVETERM_DEV_VITE"
	WaveWshForceUpdateVarName = "WAVETERM_WSHFORCEUPDATE"

	WaveJwtTokenVarName  = "WAVETERM_JWT"
	WaveSwapTokenVarName = "WAVETERM_SWAPTOKEN"
)

const (
	BlockFile_Term  = "term"            // used for main pty output
	BlockFile_Cache = "cache:term:full" // for cached block
	BlockFile_VDom  = "vdom"            // used for alt html layout
	BlockFile_Env   = "env"
)

const AppPathBinDir = "bin"

const ConfigDir = "config"

const DomainSocketBaseName = "wave.sock"

const JwtSecret = "waveterm" // TODO generate and store this

const NeedJwtConst = "NEED-JWT"

const RemoteDomainSocketBaseName = "wave-remote.sock"

const RemoteFullDomainSocketPath = "~/.waveterm/wave-remote.sock"

const RemoteFullWshBinPath = "~/.waveterm/bin/wsh"

const RemoteWaveHomeDirName = ".waveterm"

const RemoteWshBinDirName = "bin"

const WaveDBDir = "db"

const WaveLockFile = "wave.lock"

Variables

var AppPath_VarCache string // caches WAVETERM_APP_PATH

var BuildTime = "0"

var ConfigHome_VarCache string // caches WAVETERM_CONFIG_HOME

var DataHome_VarCache string // caches WAVETERM_DATA_HOME

var Dev_VarCache string // caches WAVETERM_DEV

var SupportedWshBinaries = map[string]bool{
	"darwin-x64":    true,
	"darwin-arm64":  true,
	"linux-x64":     true,
	"linux-arm64":   true,
	"windows-x64":   true,
	"windows-arm64": true,
}

var WaveVersion = "0.0.0"

set by main-server.go

Functions

func CacheAndRemoveEnvVars

func CacheAndRemoveEnvVars() error

func CacheEnsureDir

func CacheEnsureDir(dirName string, cacheKey string, perm os.FileMode, dirDesc string) error

func ClientArch

func ClientArch() string

func DetermineLang

func DetermineLang() string

func DetermineLocale

func DetermineLocale() string

func EnsureWaveConfigDir

func EnsureWaveConfigDir() error

func EnsureWaveDBDir

func EnsureWaveDBDir() error

func EnsureWaveDataDir

func EnsureWaveDataDir() error

func EnsureWavePresetsDir

func EnsureWavePresetsDir() error

func ExpandHomeDir

func ExpandHomeDir(pathStr string) (string, error)

func ExpandHomeDirSafe

func ExpandHomeDirSafe(pathStr string) string

func GetDomainSocketName

func GetDomainSocketName() string

func GetHomeDir

func GetHomeDir() string

func GetWaveAppBinPath

func GetWaveAppBinPath() string

func GetWaveAppPath

func GetWaveAppPath() string

func GetWaveConfigDir

func GetWaveConfigDir() string

func GetWaveDataDir

func GetWaveDataDir() string

func IsDevMode

func IsDevMode() bool

func ReplaceHomeDir

func ReplaceHomeDir(pathStr string) string

func TryMkdirs

func TryMkdirs(dirName string, perm os.FileMode, dirDesc string) error

func UnameKernelRelease

func UnameKernelRelease() string

func ValidateWshSupportedArch

func ValidateWshSupportedArch(os string, arch string) error

Types

type FDLock

type FDLock interface {
	Close() error
}

func AcquireWaveLock

func AcquireWaveLock() (FDLock, error)