env

Documentation

Index

• Constants
• func AllowDirenv() error
• func CheckDirenvHook() bool
• func CheckDirenvInstalled() bool
• func CheckGitignore() (bool, error)
• func CreateEnvironmentDir(slug string) error
• func CreateInitiatDir() error
• func EnsureGitignore() error
• func GenerateEnvrc() error
• func GenerateEnvrcToPath(envrcPath string) error
• func GetActiveEnvironment() (string, error)
• func GetActivePath() (string, error)
• func GetDirenvVersion() (string, error)
• func GetEnvironmentPath(slug string) (string, error)
• func GetEnvironmentSecrets(envSlug string) ([]types.Secret, error)
• func GetEnvironmentsPath() (string, error)
• func GetGitignoreStatus() (string, error)
• func GetInitiatPath() (string, error)
• func GetInstallInstructions() string
• func GetLastSyncTime(envSlug string) (time.Time, error)
• func GetSecretsPath(envSlug string) (string, error)
• func IsGitRepository() bool
• func IsInitCompleted() bool
• func LocalEnvironmentExists(slug string) bool
• func PromptForShellType() (string, error)
• func ReadSecrets(envSlug string) (string, error)
• func ReloadDirenv() error
• func SetActiveEnvironment(slug string) error
• func SyncAllEnvironments(orgSlug, projectSlug string) error
• func SyncEnvironment(envSlug, orgSlug, projectSlug string) error
• func UnsetActiveEnvironment() error
• func WriteDirenvHookToShellConfig(shellType string) error
• func WriteSecrets(envSlug string, content string) error
• type EnvironmentInfo
  • func ListLocalEnvironments() ([]EnvironmentInfo, error)
• type LocalEnvironment
• type State

Constants

const (
	InitiatDir          = ".initiat"
	EnvironmentsDir     = "environments"
	ActiveFile          = "active"
	SecretsFile         = "secrets.env"
	EnvrcFile           = ".envrc"
	WindowsOS           = "windows"
	GitignoreConfigured = "configured"
)

const (
	GitignorePerms = 0644
)

Functions

func AllowDirenv

func AllowDirenv() error

func CheckDirenvHook

func CheckDirenvHook() bool

func CheckDirenvInstalled

func CheckDirenvInstalled() bool

func CheckGitignore

func CheckGitignore() (bool, error)

func CreateEnvironmentDir

func CreateEnvironmentDir(slug string) error

func CreateInitiatDir

func CreateInitiatDir() error

func EnsureGitignore

func EnsureGitignore() error

func GenerateEnvrc

func GenerateEnvrc() error

func GenerateEnvrcToPath

func GenerateEnvrcToPath(envrcPath string) error

func GetActiveEnvironment

func GetActiveEnvironment() (string, error)

func GetActivePath

func GetActivePath() (string, error)

func GetDirenvVersion

func GetDirenvVersion() (string, error)

func GetEnvironmentPath

func GetEnvironmentPath(slug string) (string, error)

func GetEnvironmentSecrets

func GetEnvironmentSecrets(envSlug string) ([]types.Secret, error)

func GetEnvironmentsPath

func GetEnvironmentsPath() (string, error)

func GetGitignoreStatus

func GetGitignoreStatus() (string, error)

func GetInitiatPath

func GetInitiatPath() (string, error)

func GetInstallInstructions

func GetInstallInstructions() string

func GetLastSyncTime

func GetLastSyncTime(envSlug string) (time.Time, error)

func GetSecretsPath

func GetSecretsPath(envSlug string) (string, error)

func IsGitRepository

func IsGitRepository() bool

func IsInitCompleted

func IsInitCompleted() bool

func LocalEnvironmentExists

func LocalEnvironmentExists(slug string) bool

func PromptForShellType

func PromptForShellType() (string, error)

func ReadSecrets

func ReadSecrets(envSlug string) (string, error)

func ReloadDirenv

func ReloadDirenv() error

func SetActiveEnvironment

func SetActiveEnvironment(slug string) error

func SyncAllEnvironments

func SyncAllEnvironments(orgSlug, projectSlug string) error

func SyncEnvironment

func SyncEnvironment(envSlug, orgSlug, projectSlug string) error

func UnsetActiveEnvironment

func UnsetActiveEnvironment() error

func WriteDirenvHookToShellConfig

func WriteDirenvHookToShellConfig(shellType string) error

func WriteSecrets

func WriteSecrets(envSlug string, content string) error

Types

type EnvironmentInfo

type EnvironmentInfo struct {
	Slug         string
	Name         string
	IsActive     bool
	Synced       time.Time
	HasSecrets   bool
	SecretsCount int
}

func ListLocalEnvironments

func ListLocalEnvironments() ([]EnvironmentInfo, error)

type LocalEnvironment

type LocalEnvironment struct {
	Slug       string
	Path       string
	Synced     time.Time
	HasSecrets bool
}

type State

type State struct {
	Active string
}