File-Tracker

A CLI tool to keep track of files on sub-projects. Edit one and run the code to update the others.

Table of Contents

1. Documentation
   1. Installation
   2. Init
   3. Update
   4. Customization

Philosophy

File-Tracker is a tool made for you to easily share some files between projects, depending on a single file called tracker.json and avoiding using git submodules and/or Bit.

Concepts

Each tracker.json file can have 2 sections:

Blueprints: Where resides the location of the previously made tracker.json, and from where the program will get the files.

Tracker: The files that this directory is serving to any other project that have it registered under the Blueprints array.

Note: File-Tracker is on early stages of development and a few bugs are expected. Info and bug-fix recommendations are welcome.

Documentation

Installation

npm install -g file-tracker

Init

To init, just type:

file-tracker init

The prompt will ask you to select which method to init: Blueprints ou Tracking

Update

To update the files, just type:

file-tracker update

The prompt will check if the registered blueprints exists, search for the files there and make a (overwriting) copy of them in the destination folder.

Customization

You can edit the tracker.json file as free as you want to customize it to your needs!