{"id":13439076,"url":"https://github.com/technicalpickles/homesick","last_synced_at":"2025-04-10T02:13:53.954Z","repository":{"id":829234,"uuid":"545937","full_name":"technicalpickles/homesick","owner":"technicalpickles","description":"Your home directory is your castle. Don't leave your dotfiles behind.","archived":false,"fork":false,"pushed_at":"2020-10-19T07:53:51.000Z","size":388,"stargazers_count":2401,"open_issues_count":14,"forks_count":123,"subscribers_count":32,"default_branch":"master","last_synced_at":"2025-04-10T02:13:46.810Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/technicalpickles.png","metadata":{"files":{"readme":"README.markdown","changelog":"ChangeLog.markdown","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-03-04T05:22:50.000Z","updated_at":"2025-04-08T09:15:44.000Z","dependencies_parsed_at":"2022-08-16T11:05:09.727Z","dependency_job_id":null,"html_url":"https://github.com/technicalpickles/homesick","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technicalpickles%2Fhomesick","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technicalpickles%2Fhomesick/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technicalpickles%2Fhomesick/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technicalpickles%2Fhomesick/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/technicalpickles","download_url":"https://codeload.github.com/technicalpickles/homesick/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248142902,"owners_count":21054671,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T03:01:10.935Z","updated_at":"2025-04-10T02:13:53.934Z","avatar_url":"https://github.com/technicalpickles.png","language":"Ruby","funding_links":[],"categories":["HarmonyOS","Ruby","Archive/abandoned projects"],"sub_categories":["Windows Manager","macOS"],"readme":"# homesick\n\n[![Gem Version](https://badge.fury.io/rb/homesick.svg)](http://badge.fury.io/rb/homesick)\n[![Build Status](https://travis-ci.org/technicalpickles/homesick.svg?branch=master)](https://travis-ci.org/technicalpickles/homesick)\n[![Dependency Status](https://gemnasium.com/technicalpickles/homesick.svg)](https://gemnasium.com/technicalpickles/homesick)\n[![Coverage Status](https://coveralls.io/repos/technicalpickles/homesick/badge.png)](https://coveralls.io/r/technicalpickles/homesick)\n[![Code Climate](https://codeclimate.com/github/technicalpickles/homesick.svg)](https://codeclimate.com/github/technicalpickles/homesick)\n[![Gitter chat](https://badges.gitter.im/technicalpickles/homesick.svg)](https://gitter.im/technicalpickles/homesick)\n\nYour home directory is your castle. Don't leave your dotfiles behind.\n\nHomesick is sorta like [rip](http://github.com/defunkt/rip), but for dotfiles. It uses git to clone a repository containing dotfiles, and saves them in `~/.homesick`. It then allows you to symlink all the dotfiles into place with a single command.\n\nWe call a repository that is compatible with homesick to be a 'castle'. To act as a castle, a repository must be organized like so:\n\n* Contains a 'home' directory\n* 'home' contains any number of files and directories that begin with '.'\n\nTo get started, install homesick first:\n\n    gem install homesick\n\nNext, you use the homesick command to clone a castle:\n\n    homesick clone git://github.com/technicalpickles/pickled-vim.git\n\nAlternatively, if it's on github, there's a slightly shorter way:\n\n    homesick clone technicalpickles/pickled-vim\n\nWith the castle cloned, you can now link its contents into your home dir:\n\n    homesick link pickled-vim\n\nYou can remove symlinks anytime when you don't need them anymore\n\n    homesick unlink pickled-vim\n\nIf you need to add further configuration steps you can add these in a file called '.homesickrc' in the root of a castle. Once you've cloned a castle with a .homesickrc run the configuration with:\n\n    homesick rc CASTLE\n\nThe contents of the .homesickrc file must be valid Ruby code as the file will be executed with Ruby's eval construct. The .homesickrc is also passed the current homesick object during its execution and this is available within the .homesickrc file as the 'self' variable. As the rc operation can be destructive the command normally asks for confirmation before proceeding. You can bypass this by passing the '--force' option, for example `homesick rc --force CASTLE`.\n\nIf you're not sure what castles you have around, you can easily list them:\n\n    homesick list\n\nTo pull your castle (or all castles):\n\n    homesick pull --all|CASTLE\n\nTo commit your castle's changes:\n\n    homesick commit CASTLE\n\nTo push your castle:\n\n    homesick push CASTLE\n\nTo open a terminal in the root of a castle:\n\n    homesick cd CASTLE\n\nTo open your default editor in the root of a castle (the $EDITOR environment variable must be set):\n\n    homesick open CASTLE\n\nTo execute a shell command inside the root directory of a given castle:\n\n    homesick exec CASTLE COMMAND\n\nTo execute a shell command inside the root directory of every cloned castle:\n\n    homesick exec_all COMMAND\n\nNot sure what else homesick has up its sleeve? There's always the built in help:\n\n    homesick help\n\nIf you ever want to see what version of homesick you have type:\n\n    homesick version|-v|--version\n\n## .homesick_subdir\n\n`homesick link` basically makes symlink to only first depth in `castle/home`. If you want to link nested files/directories, please use .homesick_subdir.\n\nFor example, when you have castle like this:\n\n    castle/home\n    `-- .config\n        `-- fooapp\n            |-- config1\n            |-- config2\n            `-- config3\n\nand have home like this:\n\n    $ tree -a\n    ~\n    |-- .config\n    |   `-- barapp\n    |         |-- config1\n    |         |-- config2\n    |         `-- config3\n    `-- .emacs.d\n        |-- elisp\n        `-- inits\n\nYou may want to symlink only to `castle/home/.config/fooapp` instead of `castle/home/.config` because you already have `~/.config/barapp`. In this case, you can use .homesick_subdir. Please write \"directories you want to look up sub directories (instead of just first depth)\" in this file.\n\ncastle/.homesick_subdir\n\n    .config\n\nand run `homesick link CASTLE`. The result is:\n\n    ~\n    |-- .config\n    |   |-- barapp\n    |   |     |-- config1\n    |   |     |-- config2\n    |   |     `-- config3\n    |   `-- fooapp        -\u003e castle/home/.config/fooapp\n    `-- .emacs.d\n        |-- elisp\n        `-- inits\n\nOr `homesick track NESTED_FILE CASTLE` adds a line automatically. For example:\n\n    homesick track .emacs.d/elisp castle\n\ncastle/.homesick_subdir\n\n    .config\n\t.emacs.d\n\nhome directory\n\n    ~\n    |-- .config\n    |   |-- barapp\n    |   |     |-- config1\n    |   |     |-- config2\n    |   |     `-- config3\n    |   `-- fooapp        -\u003e castle/home/.config/fooapp\n    `-- .emacs.d\n        |-- elisp         -\u003e castle/home/.emacs.d/elisp\n        `-- inits\n\nand castle\n\n    castle/home\n    |-- .config\n    |   `-- fooapp\n    |       |-- config1\n    |       |-- config2\n    |      `-- config3\n    `-- .emacs.d\n        `-- elisp\n\n## Supported Ruby Versions\n\nHomesick is tested on the following Ruby versions:\n\n* 2.2.6\n* 2.3.3\n* 2.4.0\n\n## Note on Patches/Pull Requests\n\n* Fork the project.\n* Make your feature addition or bug fix.\n* Add tests for it. This is important so I don't break it in a future version unintentionally.\n* Commit, do not mess with rakefile, version, or history.  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)\n* Send me a pull request. Bonus points for topic branches.\n\n## Need homesick without the ruby dependency?\n\nCheck out [homeshick](https://github.com/andsens/homeshick).\n\n## Copyright\n\nCopyright (c) 2010 Joshua Nichols. See LICENSE for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechnicalpickles%2Fhomesick","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftechnicalpickles%2Fhomesick","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechnicalpickles%2Fhomesick/lists"}