Install

To install linkquest-cli as a global command to use anywhere you can use:

$ npm install -g linkquest

Usage

To use linkquest, all you need is the name of the page or site to crawl:

$ linkquest https://example.com/

This will crawl the page and save the output to the current working directory. If you want to instead crawl the whole host, you have to use the -h or --host option.

$ linkquest https://example.com/ -h

Flags

To customize linkquest, you can use a combination of the flags below:

linkquest [options] <url>

-h, --host          Crawl the entire host instead of just the provided url.
-o, --output        Specify the directory to save the the "linkquest.json" file that contains the results of the crawl. Defaults to the current directory that the command is being used in.
-s, --silent        Hides all console output.

Examples

Crawling a host and saving the output to a Downloads folder:

linkquest -o /c/Users/Me/Downloads/ https://example.com/

Crawling a single page:

linkquest https://example.com/example

Tests

To run the tests available for linkquest-cli, use:

$ npm run test

License

MIT