filepaths

Documentation

Index

• Constants
• Variables
• func AvailableVersionsFilePath() string
• func BackupsDir() string
• func ConnectionStatePath() string
• func DashboardServiceStateFilePath() string
• func DatabaseVersionFilePath() string
• func DefaultVarsFilePath(workspacePath string) string
• func EnsureBackupsDir() string
• func EnsureConfigDir() string
• func EnsureDashboardAssetsDir() string
• func EnsureDatabaseDir() string
• func EnsureInternalDir() string
• func EnsureLogDir() string
• func EnsurePluginDir() string
• func EnsureTemplateDir() string
• func FindPluginFolder(remoteSchema string) (string, error)
• func GetPluginPath(plugin, pluginShortName string) (string, error)
• func IsModInstallShadowPath(dirName string) bool
• func LegacyDashboardAssetsDir() string
• func LegacyNotificationsFilePath() string
• func LegacyStateFilePath() string
• func LegacyVersionFilePath() string
• func ModFilePath(modFolder string) string
• func PluginManagerStateFilePath() string
• func PluginVersionFilePath() string
• func ReportAssetsVersionFilePath() string
• func RunningInfoFilePath() string
• func StateFileName() string
• func StateFilePath() string
• func WorkspaceLockPath(workspacePath string) string
• func WorkspaceModPath(workspacePath string) string
• func WorkspaceModShadowPath(workspacePath string) string
• func WorkspaceProfileDir(installDir string) (string, error)

Constants

const (
	WorkspaceDataDir            = ".steampipe"
	WorkspaceModDir             = "mods"
	WorkspaceModShadowDirPrefix = ".mods."
	WorkspaceConfigFileName     = "workspace.spc"
	WorkspaceIgnoreFile         = ".steampipeignore"
	ModFileName                 = "mod.sp"
	DefaultVarsFileName         = "steampipe.spvars"
	WorkspaceLockFileName       = ".mod.cache.json"
)

mod related constants

const (
	DefaultInstallDir = "~/.steampipe"
)

Constants for Config

Variables

var SteampipeDir string

Functions

func AvailableVersionsFilePath

func AvailableVersionsFilePath() string

AvailableVersionsFilePath returns the path of the json file used to store cache available versions of installed plugins and the CLI

func BackupsDir

func BackupsDir() string

BackupsDir returns the path to the backups directory

func ConnectionStatePath

func ConnectionStatePath() string

ConnectionStatePath returns the path of the connections state file

func DashboardServiceStateFilePath

func DashboardServiceStateFilePath() string

func DatabaseVersionFilePath

func DatabaseVersionFilePath() string

DatabaseVersionFilePath returns the plugin version file path

func DefaultVarsFilePath

func DefaultVarsFilePath(workspacePath string) string

func EnsureBackupsDir

func EnsureBackupsDir() string

EnsureBackupsDir returns the path to the backups directory (creates if missing)

func EnsureConfigDir

func EnsureConfigDir() string

EnsureConfigDir returns the path to the config directory (creates if missing)

func EnsureDashboardAssetsDir

func EnsureDashboardAssetsDir() string

func EnsureDatabaseDir

func EnsureDatabaseDir() string

EnsureDatabaseDir returns the path to the db directory (creates if missing)

func EnsureInternalDir

func EnsureInternalDir() string

EnsureInternalDir returns the path to the internal directory (creates if missing)

func EnsureLogDir

func EnsureLogDir() string

EnsureLogDir returns the path to the db log directory (creates if missing)

func EnsurePluginDir

func EnsurePluginDir() string

EnsurePluginDir returns the path to the plugins directory (creates if missing)

func EnsureTemplateDir

func EnsureTemplateDir() string

EnsureTemplateDir returns the path to the templates directory (creates if missing)

func FindPluginFolder

func FindPluginFolder(remoteSchema string) (string, error)

FindPluginFolder searches for a folder which when hashed would match the schema

func GetPluginPath

func GetPluginPath(plugin, pluginShortName string) (string, error)

func IsModInstallShadowPath

func IsModInstallShadowPath(dirName string) bool

func LegacyDashboardAssetsDir

func LegacyDashboardAssetsDir() string

LegacyDashboardAssetsDir returns the path to the legacy report assets folder

func LegacyNotificationsFilePath

func LegacyNotificationsFilePath() string

LegacyNotificationsFilePath returns the path of the (legacy) notifications.json file used to store update notifications

func LegacyStateFilePath

func LegacyStateFilePath() string

LegacyStateFilePath returns the path of the legacy update-check.json state file

func LegacyVersionFilePath

func LegacyVersionFilePath() string

LegacyVersionFilePath returns the legacy version file path

func ModFilePath

func ModFilePath(modFolder string) string

func PluginManagerStateFilePath

func PluginManagerStateFilePath() string

func PluginVersionFilePath

func PluginVersionFilePath() string

PluginVersionFilePath returns the plugin version file path

func ReportAssetsVersionFilePath

func ReportAssetsVersionFilePath() string

ReportAssetsVersionFilePath returns the report assets version file path

func RunningInfoFilePath

func RunningInfoFilePath() string

func StateFileName

func StateFileName() string

func StateFilePath

func StateFilePath() string

StateFilePath returns the path of the update_check.json state file

func WorkspaceLockPath

func WorkspaceLockPath(workspacePath string) string

func WorkspaceModPath

func WorkspaceModPath(workspacePath string) string

func WorkspaceModShadowPath

func WorkspaceModShadowPath(workspacePath string) string

func WorkspaceProfileDir

func WorkspaceProfileDir(installDir string) (string, error)

WorkspaceProfileDir returns the path to the workspace profiles directory if STEAMPIPE_WORKSPACE_PROFILES_LOCATION is set use that otherwise look in the config folder NOTE: unlike other path functions this accepts the install-dir as arg this is because of the slightly complex bootstrapping process required because the install-dir may be set in the workspace profile