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>
This commit is contained in:
@@ -34,6 +34,7 @@ A sgard repository is a single directory with this structure:
|
|||||||
```
|
```
|
||||||
<repo>/
|
<repo>/
|
||||||
manifest.yaml # single manifest tracking all files
|
manifest.yaml # single manifest tracking all files
|
||||||
|
.gitignore # excludes blobs/ (created by sgard init)
|
||||||
blobs/
|
blobs/
|
||||||
a1/b2/a1b2c3d4... # content-addressable file storage
|
a1/b2/a1b2c3d4... # content-addressable file storage
|
||||||
```
|
```
|
||||||
@@ -134,39 +135,28 @@ sgard restore --repo /mnt/usb/dotfiles
|
|||||||
|
|
||||||
```
|
```
|
||||||
sgard/
|
sgard/
|
||||||
cmd/
|
cmd/sgard/ # CLI entry point — one file per command
|
||||||
sgard/ # CLI entry point
|
|
||||||
main.go # cobra root command, --repo flag
|
main.go # cobra root command, --repo flag
|
||||||
init.go # sgard init
|
version.go # sgard version (ldflags-injected)
|
||||||
add.go # sgard add
|
init.go add.go remove.go checkpoint.go
|
||||||
remove.go # sgard remove
|
restore.go status.go verify.go list.go diff.go
|
||||||
checkpoint.go # sgard checkpoint
|
|
||||||
restore.go # sgard restore
|
|
||||||
status.go # sgard status
|
|
||||||
verify.go # sgard verify
|
|
||||||
list.go # sgard list
|
|
||||||
diff.go # sgard diff
|
|
||||||
sgardd/ # gRPC server entry point (Phase 2)
|
|
||||||
|
|
||||||
garden/ # Core business logic
|
garden/ # Core business logic — one file per operation
|
||||||
garden.go # Garden struct: orchestrates manifest + store + filesystem
|
garden.go # Garden struct, Init, Open, Add, Checkpoint, Status
|
||||||
garden_test.go
|
restore.go # Restore with timestamp comparison and confirm callback
|
||||||
|
remove.go verify.go list.go diff.go
|
||||||
hasher.go # SHA-256 file hashing
|
hasher.go # SHA-256 file hashing
|
||||||
diff.go # File diff generation
|
e2e_test.go # Full lifecycle integration test
|
||||||
|
|
||||||
manifest/ # YAML manifest parsing
|
manifest/ # YAML manifest parsing
|
||||||
manifest.go # Manifest and Entry structs, Load/Save
|
manifest.go # Manifest and Entry structs, Load/Save
|
||||||
manifest_test.go
|
|
||||||
|
|
||||||
store/ # Content-addressable blob storage
|
store/ # Content-addressable blob storage
|
||||||
store.go # Store struct: Write/Read/Exists/Delete
|
store.go # Store struct: Write/Read/Exists/Delete
|
||||||
store_test.go
|
|
||||||
|
|
||||||
proto/ # gRPC service definition (Phase 2)
|
flake.nix # Nix flake for building on NixOS
|
||||||
sgard/v1/
|
.goreleaser.yaml # GoReleaser config for releases
|
||||||
sgard.proto
|
.github/workflows/ # GitHub Actions release pipeline
|
||||||
|
|
||||||
server/ # gRPC server implementation (Phase 2)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Key Architectural Rule
|
### Key Architectural Rule
|
||||||
@@ -180,14 +170,17 @@ type Garden struct {
|
|||||||
manifest *manifest.Manifest
|
manifest *manifest.Manifest
|
||||||
store *store.Store
|
store *store.Store
|
||||||
root string // repository root directory
|
root string // repository root directory
|
||||||
|
manifestPath string
|
||||||
|
clock clockwork.Clock // injectable for testing
|
||||||
}
|
}
|
||||||
|
|
||||||
func (g *Garden) Add(paths []string) error
|
func (g *Garden) Add(paths []string) error
|
||||||
func (g *Garden) Remove(paths []string) error
|
func (g *Garden) Remove(paths []string) error
|
||||||
func (g *Garden) Checkpoint(message string) error
|
func (g *Garden) Checkpoint(message string) error
|
||||||
func (g *Garden) Restore(paths []string, force bool) error
|
func (g *Garden) Restore(paths []string, force bool, confirm func(path string) bool) error
|
||||||
func (g *Garden) Status() ([]FileStatus, error)
|
func (g *Garden) Status() ([]FileStatus, error)
|
||||||
func (g *Garden) Verify() ([]VerifyResult, error)
|
func (g *Garden) Verify() ([]VerifyResult, error)
|
||||||
|
func (g *Garden) List() []manifest.Entry
|
||||||
func (g *Garden) Diff(path string) (string, error)
|
func (g *Garden) Diff(path string) (string, error)
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -201,8 +194,8 @@ as the CLI — no logic duplication.
|
|||||||
different usernames.
|
different usernames.
|
||||||
|
|
||||||
**No history.** Phase 1 stores only the latest checkpoint. For versioning,
|
**No history.** Phase 1 stores only the latest checkpoint. For versioning,
|
||||||
place the manifest under git. The `blobs/` directory should be gitignored —
|
place the repo under git — `sgard init` creates a `.gitignore` that excludes
|
||||||
blob durability (backup, replication) is deferred to a future phase.
|
`blobs/`. Blob durability (backup, replication) is deferred to a future phase.
|
||||||
|
|
||||||
**Per-file timestamps.** Each manifest entry records an `updated` timestamp
|
**Per-file timestamps.** Each manifest entry records an `updated` timestamp
|
||||||
set at checkpoint time. On restore, if the manifest entry is newer than the
|
set at checkpoint time. On restore, if the manifest entry is newer than the
|
||||||
@@ -213,5 +206,5 @@ on disk is newer or the times match, sgard prompts for confirmation.
|
|||||||
**Atomic writes.** Checkpoint writes `manifest.yaml.tmp` then renames to
|
**Atomic writes.** Checkpoint writes `manifest.yaml.tmp` then renames to
|
||||||
`manifest.yaml`. A crash cannot corrupt the manifest.
|
`manifest.yaml`. A crash cannot corrupt the manifest.
|
||||||
|
|
||||||
**Old C++/proto source files** are retained in the git history for reference
|
**Timestamp comparison truncates to seconds** for cross-platform filesystem
|
||||||
and will be removed as part of the Go rewrite.
|
compatibility.
|
||||||
|
|||||||
@@ -24,6 +24,11 @@ Module: `github.com/kisom/sgard`. Author: K. Isom <kyle@imap.cc>.
|
|||||||
go build ./cmd/sgard
|
go build ./cmd/sgard
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Nix:
|
||||||
|
```bash
|
||||||
|
nix build .#sgard
|
||||||
|
```
|
||||||
|
|
||||||
Run tests:
|
Run tests:
|
||||||
```bash
|
```bash
|
||||||
go test ./...
|
go test ./...
|
||||||
|
|||||||
@@ -66,3 +66,4 @@ Phase 1 is complete. Future work: blob durability, gRPC remote mode.
|
|||||||
| 2026-03-23 | 6 | Restore complete. Selective paths, force/confirm, timestamp logic, symlinks, permissions. 6 tests. |
|
| 2026-03-23 | 6 | Restore complete. Selective paths, force/confirm, timestamp logic, symlinks, permissions. 6 tests. |
|
||||||
| 2026-03-23 | 7 | Remaining commands complete. Remove, Verify, List, Diff — 10 tests across 4 parallel units. |
|
| 2026-03-23 | 7 | Remaining commands complete. Remove, Verify, List, Diff — 10 tests across 4 parallel units. |
|
||||||
| 2026-03-23 | 8 | Polish complete. golangci-lint, clockwork, e2e test, doc updates. |
|
| 2026-03-23 | 8 | Polish complete. golangci-lint, clockwork, e2e test, doc updates. |
|
||||||
|
| 2026-03-23 | — | README, goreleaser config, version command, Nix flake, homebrew formula, release pipeline validated (v0.1.0–v0.1.2). |
|
||||||
|
|||||||
@@ -28,6 +28,15 @@ Or install into `$GOBIN`:
|
|||||||
go install github.com/kisom/sgard/cmd/sgard@latest
|
go install github.com/kisom/sgard/cmd/sgard@latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
NixOS (flake):
|
||||||
|
|
||||||
|
```
|
||||||
|
nix profile install github:kisom/sgard
|
||||||
|
```
|
||||||
|
|
||||||
|
Or add to your flake inputs and include `sgard.packages.${system}.default`
|
||||||
|
in your packages.
|
||||||
|
|
||||||
Binaries are also available on the
|
Binaries are also available on the
|
||||||
[releases page](https://github.com/kisom/sgard/releases).
|
[releases page](https://github.com/kisom/sgard/releases).
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user