Series

a cli tool to open files in series starting from a base folder

Prequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.4.1
v8.16.0

Table of Contents

• Project Name
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation
  • Usage
  • Commands
    • include
    • set
    • current
    • next
  • Authors
  • License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

To install and set up the tool, run:

$ install -g https://github.com/aelmardhi/series.git

Usage

the package will use files named .series.config

to use the tool run

$ series <command> [args]

• <command> : one of the commands in Commands
• [args] : command argumnts

Commands

list of commands:

The letter in brackets is the command shortcut.

include (i)

Creates a config file in provided path, and then save it to MAIN config file.

$ series include <path>
or
$ series i <path>

• <path> : folder path to save config file.

the tool will use the closest config file to store configuration data.

set (s)

sets a path of a series, or creates a new series.

$ series set <name> <path>
or
$ series s <name> <path>

• <name> : name of a series.
• <path> : path to a series folder.

current (c)

Opens the last opend file in a series. open the first file in the series if it is the first time opend.

$ series current <name>
or
$ series c <name>

• <name> : name of a series.

next (n)

Opens the next file in a series. open the first file in the series if it is the first time opend.

$ series next <name>
or
$ series n <name>

• <name> : name of a series.

Authors

• Abdalla Elmardhi - aelmardhi

License

MIT License © aelmardhi