tail-cli

Command line interface for tailing a file in Node.js. It is built on top of Tail.

Installation

$ npm install tail-cli --save-dev
# or
$ yarn add tail-cli --dev

It requires Node@>=6.

Usage

This package provides the tail-cli command.

Options

| Option | Alias | Default value | Description | |---------------------|-----------------|-----------------|-------------| | --file <filename> | -f <filename> | | The file to tail. | | --separator | -s | "[\r]{0,1}\n" | The line separator token. It is ignored for binary files. | | --fromBeginning | --fb | false | Forces the tail of the file from the very beginning of it instead of from the first new line that will be appended | | --follow | --fw | true | Simulate tail -F option. In the case the file is moved/renamed (or logrotated), if set tail will try to start tailing again after a 1 second delay, if it is not set it will just emit an error event. | | --useWatchFile | --uwf | false | If set to true it will force the use of fs.watchFile rather than delegating to the library the choice between fs.watch and fs.watchFile. | --encoding | -e | "utf-8" | The encoding of the file to tail. | | --flushAtEOF | --feof | false | Set it if you want to force flush of content when end of file is reached. Particularly useful when there is no separator character at the end of the file. | | --verbose | -v | false | Display verbose log output to the console. | | --help | -h | | Show help. |

The --file/-f parameter is required.

For boolean values, the following options are equivalent:

Setting the value to true:

• option only: e.g. --verbose
• explicitly: e.g. --verbose true

Setting the value to false:

• prefix with --no-: e.g. --no-verbose
• explicitly: e.g. --verbose false

npm-script example

{
  "scripts": {
    "tail-error-log": "tail-cli -f logs/error.log"
  }
}

License

MIT. Please see LICENSE file for more details.