Help us shape the future of Go! Take the 2026 Go Developer Survey

scaffold

package
v0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2026 License: AGPL-3.0 Imports: 4 Imported by: 0

Documentation

Overview

Package scaffold creates a new user's jungi configuration directory structure on first startup, so every later path resolution (settings, logs, skills, hooks, plugins) finds its directory already present.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Result

type Result struct {
	// CreatedConfigDir reports whether ~/.config/jungi/ did not already
	// exist and was created.
	CreatedConfigDir bool
	// CreatedSettingsFile reports whether the default settings.toml
	// template was written because no settings file existed yet.
	CreatedSettingsFile bool
}

Result describes the scaffolding performed by EnsureUserConfig, so callers can report what happened (e.g. a first-run notice on the idle screen).

func EnsureUserConfig

func EnsureUserConfig() (Result, error)

EnsureUserConfig creates the config, logs, skills, hooks, plugins, and cache directories if they do not already exist, and writes the embedded default settings.toml when no settings file is present.

An existing settings.toml is never overwritten or merged into — the user's file is authoritative.

Source Files

  • scaffold.go

Jump to

Keyboard shortcuts

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