README
Alia
Alias To Go
Works on Linux, Windows and maybe macOS (not tried).
Install
$ npm install -g alia
Usage
$ al --help
Gist sync
Alia allows you to backup/restore config from a gist using the commands:
al --sync push
to backup your config (push to gist)al --sync pull
to restore your config (pull from gist)
To get started:
- Create a new gist with a file titled
alia.json
. - Create a new GitHub token with the 'gist' permission.
- Setup Alia with the following commands:
al --conf token <api token>
al --conf gist <32-char gist id>
Developing
These instructions will help get you up and running with Alia on your local machine.
Prerequisites
- Node: Version 6 or higher
Installing
Single line setup (or follow the steps below)
git clone https://github.com/edkotkas/alia.git && cd alia && npm i && npm link && al
- Clone the repository (or fork it).
git clone https://github.com/edkotkas/alia.git && cd alia
- Install the NPM packages.
npm i
- (Optional) Symlink the project to your global NPM folder. This will allow you to run Alia using the cli command ("al").
npm link
- Run
$ al --help
- Alternatively, without symlink (will still create a global config file in your home directory).
$ node index --help
- Add issues to Github, make changes to the project and create pull requests for review.
Tests
Run the tests with mocha.
npm test
License
ISC © Eduard Kotkas