gitbin

bin dotfiles and configs easily for use with git

npm install gitbin
18 downloads in the last week
37 downloads in the last month

gitbin

Not Fully Operational.

gitbin collects scattered dotfiles, configuration files, documents or anything really into a central directory for usage with git. It uses the same command-line syntax as git for ease of use and replicates much of the same basic functionality. Once a file is added, gitbin remembers where the file is and the push commands will re-copy the file on the filesystem into the designated gitbin folder.

Build Status

How to Install

sudo npm install gitbin -g

How to use

Initialize a directory

To begin using gitbin you must initialize a bin (directory) to be used as the local repository for your files. This adds the bin into the global gitbin register .globalstate.json

gitbin init

Add file to bin and track file

To add a file to bin head to the directory containing the file and run add command. This both copies the file to the current bin as well as adding the file to the bin local registry .trackedfiles.json.

gitbin add <file1> <file2> ...

Remove tracking from file

To stop tracking a file, meaning the file will not be part of any push or pull commands use the remove command. Note that this will not actually delete the file from the bin directory. This should be done with the unix rm command.

gitbin rm <file1> <file2> ...

List bins

gitbin allows usage of more than one bin. If you have initialized more than one bin (directory) you can list the bins gitbin is linked to (in the .globalstate.json) with:

gitbin bin

Delete bin

To remove a bin from being tracked by gitbin do:

gitbin bin -d <bin>

Deleting a bin will only remove it from the .globalstate.json file preventing gitbin from accessing this bin. The .trackedfiles.json is not unlinked from the directory so using the init command will both restore the bin and the files previously tracked. To seriously delete a bin, deleting it from gitbin statefiles and unlinking it via unix commands are necessary.

Checkout bin

To change the active bin which gitbin points to for it's other commands use:

gitbin checkout <bin>

where <bin> is the name of the bin as listed by the node gitbin bin command.

Push changes to bin

Once files have are being tracked by gitbin and changes to those files are made in the original file locations on the filesystem running the push command copies those files and replaces the files in the bin with the newer versions. Git can then be used to version and add to a repository.

gitbin push

Note: as protection against accidentally pushing to the wrong bin, the push command will yeild a warning announcing the current bin the push will be performed on and waiting user input.

Pull changes from bin to filesystem

NON FUNCTIONAL

This may or may not be implemented as it has the potential for grief. However, on a new machine it would be nice to pull from github then push to the filesystem. Perhaps file by file input regarding file replacement and path creation would mitigate potential information loss. An -f force switch could turn this caution feature off.

gitbin pull

Fetch single file from bin into filessytem

NON FUNCTIONAL

This is the cautious route, or when certain files are specific to another machine and just the shared files are needed to be pulled from the bin to the local filesystem.

gitbin fetch <file1> <filen>

Check status

This borrows that most handy git feature and lists all bins registered as well as marking the bin currently in use (the active bin) and the files registered to that bin.

gitbin status

Stuff to do:

  • make it so users can not add files in a bin directory
  • status should check time stamps for useful info
  • make sure arguements go in as array
  • Use errors to propagate non-error messages to be printed to terminal. This would help test coverage on printed messages.
  • If active bin deleted either a) bump the active true to next bin, b) make sure in tests user is warned about checking out a bin.
npm loves you