sitemap-generator-cli

Sitemap Generator CLI

Create xml sitemaps from the command line.

Generates a sitemap by crawling your site. Uses streams to efficiently write the sitemap to your drive. Is cappable of creating multiple sitemaps if threshold is reached. Respects robots.txt and meta tags.

Table of contents

• Install
• Usage
• Options
• License

Install

This module is available on npm.

$ npm install -g sitemap-generator-cli

Usage

The crawler will fetch all folder URL pages and file types parsed by Google. If present the robots.txt will be taken into account and possible rules are applied for each URL to consider if it should be added to the sitemap. Also the crawler will not fetch URL's from a page if the robots meta tag with the value nofollow is present and ignore them completely if noindex rule is present. The crawler is able to apply the base value to found links.

$ sitemap-generator [options] <url> <filepath>

When the crawler finished the XML Sitemap will be built and saved to your specified filepath. If the count of fetched pages is greater than 50000 it will be splitted into several sitemap files and create a sitemapindex file. Google does not allow more than 50000 items in one sitemap.

Example:

$ sitemap-generator http://example.com some/path/sitemap.xml

Options

$ sitemap-generator --help

  Usage: cli [options] <url>

  Options:

    -h, --help                output usage information
    -V, --version             output the version number
    -f, --file                path to file including filename
    -q, --query               consider query string
    -u, --user-agent <agent>  set custom User Agent
    -v, --verbose             print details when crawling

file

Path to file to write including the filename itself. Path can be absolute or relative. Examples:

• sitemap.xml
• mymap.xml
• /var/www/sitemap.xml
• ./sitemap.myext

query

Consider URLs with query strings like http://www.example.com/?foo=bar as indiviual sites and add them to the sitemap.

user-agent

Set a custom User Agent used for crawling. Default is Node/SitemapGenerator.

verbose

Print debug messages during crawling process. Also prints out a summery when finished.

License

MIT © Lars Graubner