Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 2.62 KB

command-line.md

File metadata and controls

97 lines (65 loc) · 2.62 KB

Feri - Command Line

If installed globally, you can run the command feri from any directory. If installed locally, you'll need to run npx feri from your project folder.

Feri will clean, build, and display statistics by default. She will also assume your source folder is "./source" and your destination folder is "./dest" unless you specify otherwise.

Navigation

Usage

feri [options] [source] [destination]

Optional elements include options, source, and destination.

Options

Options come in three flavours: Common, Negating, and Special.

Common Options

-c, --clean          clean the destination directory
-b, --build          build source files to destination
-w, --watch          watch source to clean and build as needed
-e, --extensions     monitor destination directory for extensions
-s, --stats          display statistics

Feri will clean, build, and display statistics by default. If you like those behaviors you can simply type feri instead of feri --clean --build --stats.

Negating Options

-nc, --noclean       no clean
-nb, --nobuild       no build
-nw, --nowatch       no watch
-ne, --noextensions  no extensions
-ns, --nostats       no statistics

Negating options override their counterparts. For example, feri --clean --noclean would result in the destination folder not being cleaned.

Special Options

Special options can override other options, do multiple things at once, or are otherwise unique.

-a, --all            clean, build, watch, extensions, stats
-f, --forcebuild     overwrite destination files without consideration
-r, --republish      remove all destination files and then build
-i, --init           create source, destination, and custom config file
-d, --debug          enable verbose console logging
-v, --version        version
-h, --help           help

Special options like --all, --forcebuild, and --republish will override common and negating options.

Source

Optional source directory to build files from.

If not provided, Feri will look for a source folder in the directory you called her from.

Destination

Optional destination directory to build files to.

If not provided, Feri will look for a dest folder in the directory you called her from.

Examples

Clean, build, and stats are enabled by default.

feri

Clean, do not build, and then watch.

feri --nobuild --watch

Republish from a specific source folder to a specific destination folder.

feri --republish /path/to/source /path/to/destination