sc/sgard

Files

Kyle Isom b1313c1048 Update docs for v1.0.0.

ARCHITECTURE.md: update package structure to reflect actual file layout
(per-operation files, version command, flake, goreleaser), fix Garden
struct (clock field, Restore confirm callback, List method), add
.gitignore to repo layout, remove stale C++ note.

README.md: add NixOS installation instructions.
CLAUDE.md: add nix build command.
PROGRESS.md: add post-Step-8 release work to change log.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-03-23 22:38:53 -07:00

1.7 KiB

Raw Blame History

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Critical: Keep Project Docs Updated

Any change to the codebase MUST be reflected in these files:

ARCHITECTURE.md — design decisions, data model, package structure
PROJECT_PLAN.md — implementation steps; check off completed items
PROGRESS.md — current status, change log; update after completing any step

If another agent or engineer picks this up later, these files are how they resume. Keeping them accurate is not optional.

Project

sgard (Shimmering Clarity Gardener) — a dotfiles manager. Module: github.com/kisom/sgard. Author: K. Isom kyle@imap.cc.

Build

go build ./cmd/sgard

Nix:

nix build .#sgard

Run tests:

go test ./...

Lint:

golangci-lint run ./...

Dependencies

gopkg.in/yaml.v3 — manifest serialization
github.com/spf13/cobra — CLI framework
github.com/jonboulle/clockwork — injectable clock for deterministic tests

Package Structure

cmd/sgard/    CLI entry point (cobra commands, pure wiring)
garden/       Core business logic (Garden struct orchestrating everything)
manifest/     YAML manifest parsing (Manifest/Entry structs, Load/Save)
store/        Content-addressable blob storage (SHA-256 keyed)

Key rule: all logic lives in garden/. The cmd/ layer only parses flags and calls Garden methods. This enables the future gRPC server to reuse the same logic with zero duplication.

Each garden operation (remove, verify, list, diff) lives in its own file (garden/<op>.go) to minimize merge conflicts during parallel development.

1.7 KiB Raw Blame History