initcmd

package

v0.4.0 Latest Latest Go to latest Published: Jul 7, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sofia-ctx/sofia

Links

Open Source Insights

Documentation ¶

Overview ¶

Package initcmd implements `sf init` — one-shot per-project onboarding that wires sf up for a project's coding agents: a managed block in AGENTS.md, the sf-context skill, the PreToolUse hook, and MCP server registration. Steps beyond the AGENTS.md block are gated on whether Claude Code is detected on the machine and/or in the project, and --corporate skips all of them for locked-down environments where only instruction files are writable.

Index ¶

func NewCommand() *cobra.Command
func Run(opts Options, w io.Writer) error
type Item
type Options
type Result

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewCommand ¶

func NewCommand() *cobra.Command

NewCommand returns the `init` Cobra command (`sf init`).

func Run ¶

func Run(opts Options, w io.Writer) error

Run executes the onboarding, renders the report, and logs the call.

Types ¶

type Item ¶

type Item struct {
	Name   string `json:"name"`
	Status string `json:"status"`
	Detail string `json:"detail"`
}

Item is one onboarding step's outcome — same shape as doctor.Check, same voice: a short Status plus a sentence of Detail.

type Options ¶

type Options struct {
	Project   string
	Corporate bool
	Force     bool
	Format    string
}

Options carries flag state.

type Result ¶

type Result struct {
	ClaudeOnMachine bool   `json:"claude_on_machine"`
	ClaudeInProject bool   `json:"claude_in_project"`
	Items           []Item `json:"items"`
}

Result is the full report: what was detected, and what each step did.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL