@ferusfax/ferusfax v0.3.1

Ferusfax

Ferusfax is a command line interface that helps you with various activities in your daily life.

Installation

Install the project globally, this will allow you to use Ferusfax on any terminal.

npm install -g @ferusfax/ferusfax

then run:

ferusfax

it will then perform the basic configurations and then show a help screen with the default commands.

Creating a plugin

Create your project add the dependency

npm install -g @ferusfax/type

Extends the abstract class Plugin and implient all methods

export default class MyPlugin extends Plugin {
  activate(args: string): string {
    ...
  }
}

The activate method will always be executed every time your plugin is executed.

Once your plugin has been published in your repository, simply install it using the following command

ferusfax -i

Follow the instructions and finally run ferusfax with the arguments given during installation

If you have any questions, run the help command

ferusfax -h