Documentation
¶
Index ¶
- func FindConfigDir(ctx context.Context, toolName string) (string, error)
- type Config
- type Loader
- type Vault
- func (v *Vault) GetClaudeScript() string
- func (v *Vault) GetDailyDir() string
- func (v *Vault) GetExcludes() []string
- func (v *Vault) GetGoalTemplate() string
- func (v *Vault) GetGoalsDir() string
- func (v *Vault) GetKnowledgeDir() string
- func (v *Vault) GetObjectiveTemplate() string
- func (v *Vault) GetObjectivesDir() string
- func (v *Vault) GetSessionProjectDir() string
- func (v *Vault) GetTaskTemplate() string
- func (v *Vault) GetTasksDir() string
- func (v *Vault) GetThemeTemplate() string
- func (v *Vault) GetThemesDir() string
- func (v *Vault) GetVisionDir() string
- func (v *Vault) GetVisionTemplate() string
- func (v *Vault) GetWorkOnCommand() string
- func (v *Vault) GetWorkOnGoalCommand() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FindConfigDir ¶ added in v0.96.0
FindConfigDir returns the config directory for the given tool, applying XDG-first priority. If ~/.config/<toolName>/ exists it is returned. Otherwise, if the legacy ~/.<toolName>/ directory exists, it is returned. When neither exists, the XDG path ~/.config/<toolName>/ is returned as the default for new installs. FindConfigDir never creates directories and never writes to the filesystem; it only checks directory existence via os.Stat.
Types ¶
type Config ¶
type Config struct {
CurrentUser string `yaml:"current_user"`
DefaultVault string `yaml:"default_vault"`
Vaults map[string]Vault `yaml:"vaults"`
}
Config represents the vault-cli configuration.
type Loader ¶
type Loader interface {
Load(ctx context.Context) (*Config, error)
GetVaultPath(ctx context.Context, vaultName string) (string, error)
GetVault(ctx context.Context, vaultName string) (*Vault, error)
GetAllVaults(ctx context.Context) ([]*Vault, error)
GetCurrentUser(ctx context.Context) (string, error)
}
type Vault ¶
type Vault struct {
Path string `yaml:"path" json:"path"`
Name string `yaml:"name" json:"name"`
TasksDir string `yaml:"tasks_dir,omitempty" json:"tasks_dir,omitempty"`
GoalsDir string `yaml:"goals_dir,omitempty" json:"goals_dir,omitempty"`
ThemesDir string `yaml:"themes_dir,omitempty" json:"themes_dir,omitempty"`
ObjectivesDir string `yaml:"objectives_dir,omitempty" json:"objectives_dir,omitempty"`
VisionDir string `yaml:"vision_dir,omitempty" json:"vision_dir,omitempty"`
DailyDir string `yaml:"daily_dir,omitempty" json:"daily_dir,omitempty"`
KnowledgeDir string `yaml:"knowledge_dir,omitempty" json:"knowledge_dir,omitempty"`
ClaudeScript string `yaml:"claude_script,omitempty" json:"claude_script,omitempty"`
SessionProjectDir string `yaml:"session_project_dir,omitempty" json:"session_project_dir,omitempty"`
WorkOnCommand string `yaml:"work_on_command,omitempty" json:"work_on_command,omitempty"`
WorkOnGoalCommand string `yaml:"work_on_goal_command,omitempty" json:"work_on_goal_command,omitempty"`
TaskTemplate string `yaml:"task_template,omitempty" json:"task_template,omitempty"`
GoalTemplate string `yaml:"goal_template,omitempty" json:"goal_template,omitempty"`
ThemeTemplate string `yaml:"theme_template,omitempty" json:"theme_template,omitempty"`
ObjectiveTemplate string `yaml:"objective_template,omitempty" json:"objective_template,omitempty"`
VisionTemplate string `yaml:"vision_template,omitempty" json:"vision_template,omitempty"`
Excludes []string `yaml:"excludes,omitempty" json:"excludes,omitempty"`
}
Vault represents a single vault configuration.
func (*Vault) GetClaudeScript ¶ added in v0.17.0
GetClaudeScript returns the claude script to use for sessions, defaulting to "claude" if not set.
func (*Vault) GetDailyDir ¶
GetDailyDir returns the daily notes directory, defaulting to "Daily Notes" if not set.
func (*Vault) GetExcludes ¶ added in v0.28.0
GetExcludes returns the list of excluded directory prefixes.
func (*Vault) GetGoalTemplate ¶ added in v0.57.0
GetGoalTemplate returns the resolved absolute path to the goal template, or empty string if not set.
func (*Vault) GetGoalsDir ¶
GetGoalsDir returns the goals directory, defaulting to "Goals" if not set.
func (*Vault) GetKnowledgeDir ¶ added in v0.66.2
GetKnowledgeDir returns the knowledge base directory, defaulting to "50 Knowledge Base" if not set.
func (*Vault) GetObjectiveTemplate ¶ added in v0.57.0
GetObjectiveTemplate returns the resolved absolute path to the objective template, or empty string if not set.
func (*Vault) GetObjectivesDir ¶
GetObjectivesDir returns the objectives directory, defaulting to "22 Objectives" if not set.
func (*Vault) GetSessionProjectDir ¶ added in v0.47.0
GetSessionProjectDir returns the session project directory override, or empty string if not set.
func (*Vault) GetTaskTemplate ¶ added in v0.57.0
GetTaskTemplate returns the resolved absolute path to the task template, or empty string if not set.
func (*Vault) GetTasksDir ¶
GetTasksDir returns the tasks directory, defaulting to "Tasks" if not set.
func (*Vault) GetThemeTemplate ¶ added in v0.57.0
GetThemeTemplate returns the resolved absolute path to the theme template, or empty string if not set.
func (*Vault) GetThemesDir ¶
GetThemesDir returns the themes directory, defaulting to "21 Themes" if not set.
func (*Vault) GetVisionDir ¶
GetVisionDir returns the vision directory, defaulting to "20 Vision" if not set.
func (*Vault) GetVisionTemplate ¶ added in v0.57.0
GetVisionTemplate returns the resolved absolute path to the vision template, or empty string if not set.
func (*Vault) GetWorkOnCommand ¶ added in v0.66.10
GetWorkOnCommand returns the Claude slash command for starting work-on sessions, defaulting to /vault-cli:work-on-task if not configured.
func (*Vault) GetWorkOnGoalCommand ¶ added in v0.99.0
GetWorkOnGoalCommand returns the Claude slash command for starting goal work-on sessions, defaulting to /vault-cli:work-on-goal if not configured.
Source Files