Kiip

Travis Status codecov.io

Kiip, just another dotfiles tool to move your actual files and folders to a repository (which can be synced by another tool) and replace them with symlinks.

Terminology

  • Repository: the place where your packages are stored, e.g. ~/Dropbox/kiip
  • Package: The file or folder in PATH_TO_CASTLE/home/PACKAGE_NAME

Installation

$ gem install kiip

Usage

Commands:
  kiip help [COMMAND]           # Describe available commands or one specific command
  kiip list                     # lists all packages
  kiip rm NAME                  # removes package with name NAME, see: kiip help rm
  kiip sync PACKAGE_NAME        # recreates the source of the package (via symlink, copy, etc)
  kiip track PACKAGE_NAME PATH  # tracks the file or folder under PATH with the package name NAME....

Options:
  [--dry], [--no-dry]

Examples:
    kiip track ssh ~/.ssh 
    kiip list 
      ssh:
        ~/.ssh

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rweng/kiip. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.