Documentation
¶
Overview ¶
Package agentinit implements `locksql init <agent>` and the user-scope wiring of bare `locksql` and `locksql doctor --fix`: it holds locksql's texts (templates/) and wires them through lockkit's agentwire, which owns the file mechanics.
Init writes project files only. It never overwrites a file the human may have edited: an existing skill or rule is kept, an MCP config gets the locksql entry merged in (other servers and keys are kept), and a Markdown instructions file gets one marked section appended. Running it again changes nothing. Every path is resolved through symlinks and refused if it leaves the project.
User scope: wires agents through files under the home directory (and `claude mcp add --scope user`). Symlinks are followed: these are the human's own files, often managed as dotfiles.
Index ¶
Constants ¶
const ( StatusCreated = agentwire.StatusCreated StatusUpdated = agentwire.StatusUpdated StatusUnchanged = agentwire.StatusUnchanged StatusKept = agentwire.StatusKept )
Action statuses.
Variables ¶
This section is empty.
Functions ¶
func PendingUser ¶ added in v0.1.2
PendingUser reports whether InitUser would write or run anything.
func ProjectRoot ¶
ProjectRoot returns the directory init writes to: the nearest ancestor of cwd holding .locksql/config.toml, else the nearest one holding .git, else cwd itself.
Types ¶
type Env ¶ added in v0.1.2
Env is the user account init works on, and how it looks for and runs the agents' commands.
Source Files