Files
gosick/README.md
Micheal Wilkinson 8fc831dfdf
All checks were successful
Push Validation / validate (push) Successful in 1m52s
chore(ci): re-enable Go module caching and add coverage badge to README
2026-03-20 13:55:09 +00:00

1.8 KiB

homesick

Main Validation PR Validation Tag Build Artifacts Coverage

Your home directory is your castle. Don't leave your dotfiles behind.

This repository now contains a Go implementation of Homesick. A dotfiles repository is called a castle and should contain a home/ directory with files to link into your $HOME.

Build

Build with just:

just go-build

Or directly with Go:

go build -o dist/gosick ./cmd/homesick

Commands

Implemented commands:

  • clone URI [CASTLE_NAME]
  • list
  • show_path [CASTLE]
  • status [CASTLE]
  • diff [CASTLE]
  • link [CASTLE]
  • unlink [CASTLE]
  • track FILE [CASTLE]
  • version

Not yet implemented:

  • pull
  • push
  • commit
  • destroy
  • cd
  • open
  • exec
  • exec_all
  • rc
  • generate

Behavior Suite

The repository includes a Docker-based behavior suite that validates filesystem and git outcomes for the implemented commands.

Run behavior suite:

just behavior

Verbose behavior suite output:

just behavior-verbose

Testing

Run all Go tests:

just go-test

License

See LICENSE.