Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/agherzan/nodf

Dotfiles (and not only) manager
https://github.com/agherzan/nodf

Last synced: about 1 month ago
JSON representation

Dotfiles (and not only) manager

Awesome Lists containing this project

README

        

##Table of Contents##
- [A. Description](#a-description)
- [B. Installation](#b-installation)
- [C. How To Use](#c-how-to-use)

A. Description
==============

A tool to be used for managing and storing dotfiles but coded to be able
to accommodate any kind of files

B. Installation
===============

$ cd
$ sudo ./setup.py install

C. How To Use
=============

Help (-h) should give you enough information about all the commands currently
supported by this tool:

$ nodf -h

To clone a repository in the default location (which is ~/dotfiles), run:

$ nodf clone

If you don't have a dotfiles repository and want just to initialize a new git:

$ nodf init

After cloning the repository, you can create symlinks for all files in dotfiles
repository using:

$ nodf symlink

Note that all files in dotfiles should be relative to home directory. So, for a
file in ~/dotfile/tmp/file, this will create a symlink in ~/tmp/file.

To track a new (or some) file(s):

$ nodf track file1 file2

This will actually move these files in dotfiles repository and create symlinks
in their old location. You will probably want to add/commit/push in dotfiles
repository after this. Again, all files should be located in your HOME
directory. Obviously it doesn't matter if these files are actually dotfiles.

To list the remote origin dotfiles repository:

$ nodf list

To check status of remote dotfiles repository:

$ nodf status