@swup/cli

Create swup plugins and themes in seconds, or validate your website.

• Usage
• Commands

Usage

$ npm install -g @swup/cli
$ swup COMMAND
running command...
$ swup (-v|--version|version)
@swup/cli/0.3.4 darwin-x64 node-v10.15.3
$ swup --help [COMMAND]
USAGE
  $ swup COMMAND
...

Commands

• swup create
• swup help [COMMAND]
• swup validate

swup create

Create new swup plugin and themes in seconds.

USAGE
  $ swup create

OPTIONS
  -n, --name=name          (required) Defines name of plugin (Swup[YourName]Plugin).
  -r, --repo=repo          Defines git repository url of plugin.
  -t, --type=plugin|theme  [default: plugin] Can choose to create theme instead.

See code: src/commands/create.js

swup help [COMMAND]

display help for swup

USAGE
  $ swup help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

swup validate

Validate your site pages.

USAGE
  $ swup validate

OPTIONS
  -a, --asynchronous                                                   Execute all tests asynchronously at once (around
                                                                       5x faster, but might cause problems)

  -c, --config=config                                                  [default: swup.config.js] Defines path of swup
                                                                       config file.

  -f, --findUrls=findUrls                                              Crawl site based on defined base URL and find
                                                                       URLs to check automatically (pages that are not
                                                                       linked from other pages, like 404, won't be
                                                                       checked)

  -m, --sitemap=sitemap                                                [default: public/sitemap.xml] Sitemap file
                                                                       (accepts file path or URL)

  -o, --containers=containers                                          [default: #swup] Container selectors separated by
                                                                       a comma (,)

  -r, --runTests=all|containers|transition-duration|transition-styles  [default: all] Run only specific test.

  -s, --stylesExpectedToChange=stylesExpectedToChange                  [default: opacity,transform] Styles expected to
                                                                       change separated by a comma (,)

  -t, --testUrl=testUrl                                                Run tests for single URL.

See code: src/commands/validate.js