Documentation
¶
Overview ¶
Package paths defines the user-owned filesystem layout of the coding application without creating any files or directories.
Index ¶
- Constants
- Variables
- func ProjectAgentSkillsDir() string
- func ProjectAgentsDir() string
- func ProjectBundlesDir() string
- func ProjectHooksFile() string
- func ProjectMCPFile() string
- func ProjectPermissionsFile() string
- func ProjectPluginsDir() string
- func ProjectRoot() string
- func ProjectSharedAgentsDir() string
- func ProjectSkillsDir() string
- func ProjectSkillsFile() string
- type Layout
- func (l Layout) AgentSkillsDir() string
- func (l Layout) AgentsDir() string
- func (l Layout) BundlesDir() string
- func (l Layout) ConfigFile() string
- func (l Layout) HookTrustFile() string
- func (l Layout) HooksFile() string
- func (l Layout) MCPFile() string
- func (l Layout) PluginDataDir() string
- func (l Layout) PluginsDir() string
- func (l Layout) Root() string
- func (l Layout) SessionsDir() string
- func (l Layout) SharedAgentsDir() string
- func (l Layout) SkillsDir() string
- func (l Layout) TUIThemesDir() string
- func (l Layout) TeamAggregatesDir() string
- func (l Layout) TeamContinuationsDir() string
- func (l Layout) TeamControlDir() string
- func (l Layout) TeamIntegrationsDir() string
- func (l Layout) TeamLeasesDir() string
- func (l Layout) TeamResourcesDir() string
- func (l Layout) TeamsDir() string
- func (l Layout) TempDir() string
- func (l Layout) WithAgentSkillsDir(directory string) (Layout, error)
- func (l Layout) WithSharedAgentsDir(directory string) (Layout, error)
- func (l Layout) WorkspacesFile() string
- func (l Layout) WorktreesRoot() string
Constants ¶
const (
// HomeEnv overrides the default ~/.pips product root.
HomeEnv = "PIPS_HOME"
)
Variables ¶
var ErrInvalid = errors.New("coding paths: invalid user configuration directory")
ErrInvalid means the user configuration root cannot define a safe layout.
Functions ¶
func ProjectAgentSkillsDir ¶
func ProjectAgentSkillsDir() string
ProjectAgentSkillsDir returns the workspace-relative shared Agent Skills directory.
func ProjectAgentsDir ¶
func ProjectAgentsDir() string
ProjectAgentsDir returns the workspace-relative private Pips Agent root.
func ProjectBundlesDir ¶
func ProjectBundlesDir() string
ProjectBundlesDir returns the workspace-relative project bundle directory.
func ProjectHooksFile ¶
func ProjectHooksFile() string
ProjectHooksFile returns the workspace-relative lifecycle hook configuration path.
func ProjectMCPFile ¶
func ProjectMCPFile() string
ProjectMCPFile returns the workspace-relative MCP configuration path.
func ProjectPermissionsFile ¶
func ProjectPermissionsFile() string
ProjectPermissionsFile returns the workspace-relative local permission path.
func ProjectPluginsDir ¶
func ProjectPluginsDir() string
ProjectPluginsDir returns the trusted workspace-relative Agent Plugins root.
func ProjectRoot ¶
func ProjectRoot() string
ProjectRoot returns the workspace-relative product directory.
func ProjectSharedAgentsDir ¶
func ProjectSharedAgentsDir() string
ProjectSharedAgentsDir returns the workspace-relative shared Agent root.
func ProjectSkillsDir ¶
func ProjectSkillsDir() string
ProjectSkillsDir returns the workspace-relative project skills directory.
func ProjectSkillsFile ¶
func ProjectSkillsFile() string
ProjectSkillsFile returns the workspace-relative local Skill settings path.
Types ¶
type Layout ¶
type Layout struct {
// contains filtered or unexported fields
}
Layout contains all user-owned P0 persistence paths. Project-scoped product resources remain workspace-relative and are not part of this layout.
func (Layout) AgentSkillsDir ¶
AgentSkillsDir returns the shared user Agent Skills directory. It is empty for layouts built with New unless explicitly configured.
func (Layout) BundlesDir ¶
BundlesDir returns the user bundle directory.
func (Layout) ConfigFile ¶
ConfigFile returns the user TOML configuration path.
func (Layout) HookTrustFile ¶
HookTrustFile returns the Pips-owned lifecycle hook trust store path.
func (Layout) PluginDataDir ¶
PluginDataDir returns the client-owned persistent PLUGIN_DATA base.
func (Layout) PluginsDir ¶
PluginsDir returns the user Agent Plugins discovery root. Each immediate child is one portable package rooted by plugin.json.
func (Layout) SessionsDir ¶
SessionsDir returns the Harness session repository path.
func (Layout) SharedAgentsDir ¶
SharedAgentsDir returns the shared user Agent definition directory. It is empty for layouts built with New unless explicitly configured.
func (Layout) TUIThemesDir ¶
TUIThemesDir returns the optional user theme directory. Theme discovery never creates this directory; users may add independent *.toml definitions beneath the private product root.
func (Layout) TeamAggregatesDir ¶
TeamAggregatesDir returns the Team aggregate journal directory.
func (Layout) TeamContinuationsDir ¶
TeamContinuationsDir returns the Team continuation journal directory.
func (Layout) TeamControlDir ¶
TeamControlDir returns the operator Team control journal directory.
func (Layout) TeamIntegrationsDir ¶
TeamIntegrationsDir returns the private Integration journal directory.
func (Layout) TeamLeasesDir ¶
TeamLeasesDir returns the retained Team lease directory.
func (Layout) TeamResourcesDir ¶
TeamResourcesDir returns the Team application resource journal directory.
func (Layout) TempDir ¶
TempDir returns the legacy product-local temporary path. Production Coding Runtime execution uses an owner-managed external scratch root instead; this method remains for explicit test/embedder layouts and compatibility callers.
func (Layout) WithAgentSkillsDir ¶
WithAgentSkillsDir returns a copy that discovers shared Agent Skills from directory. An empty directory disables the shared user root. This is mainly useful for embedders and hermetic tests; Default configures ~/.agents/skills.
func (Layout) WithSharedAgentsDir ¶
WithSharedAgentsDir returns a copy that discovers shared Agent definitions from directory. An empty directory disables the shared user root. This is mainly useful for embedders and hermetic tests; Default configures ~/.agents/agents.
func (Layout) WorkspacesFile ¶
WorkspacesFile returns the workspace state store path.
func (Layout) WorktreesRoot ¶
WorktreesRoot returns the sibling root reserved for Team Worktrees.
Source Files