Git Product home page Git Product logo

dotfiles-cli's Introduction

DotFiles CLI

DotFiles CLI (dotfiles) is a simple cli to install your dotfiles into your home directory.

Features

  • Automatically cleans up files that are not tracked anymore (e.g. deleted from dotfiles)
  • Support for copying or symlinking files
  • Support for custom directories
  • Clean command to remove all files that are tracked

Installation

Download the binary from the GitHub Releases.

curl -L -o ~/.local/bin/dotfiles https://github.com/PhilippHeuer/dotfiles-cli/releases/download/v0.1.0/linux_amd64
chmod +x ~/.local/bin/dotfiles

Usage

Command Description
dotfiles install ~/git/your-dotfiles --mode symlink Installs all files by creating symlinks
dotfiles install ~/git/your-dotfiles --mode copy Installs all files by making copies
dotfiles clean Cleans all files tracked, keeping directories (from state)

The --mode flag is optional, the default is copy.

Configuration

Your ~/git/your-dotfiles should contain a dotfiles.yaml file, which defines the files to install.

directories:
- path: config
  target: $HOME/.config
- path: scripts
  target: $HOME/.local/bin

License

Released under the MIT license.

dotfiles-cli's People

Contributors

philippheuer avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.