Documentation
¶
Overview ¶
Package agentinit implements `locksql init <agent>`: it writes the files that connect a coding agent to locksql inside one project, and prints the steps for any file outside it.
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.
Index ¶
Constants ¶
const ( StatusCreated = "created" // the file did not exist StatusUpdated = "updated" // locksql was merged into an existing file StatusUnchanged = "unchanged" // the file already holds the locksql content StatusKept = "kept" // the file differs and was left as the human wrote it )
Action statuses.
const NextSteps = `` /* 155-byte string literal not displayed */
NextSteps tells the human how to finish the set-up; print it once after the notes of every agent.
Variables ¶
This section is empty.
Functions ¶
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 Action ¶
type Action struct {
Path string // slash-separated, relative to the project root
Status string
Detail string // why a file was kept, when it was
}
Action reports what Init did to one file.
Source Files