vtp-agent

A low-level Node process for interacting with Vtp.

• Usage
• Commands

Usage

$ npm install -g vtp-agent
$ vtp COMMAND
running command...
$ vtp (-v|--version|version)
vtp-agent/0.8.6 darwin-x64 node-v10.16.0
$ vtp --help [COMMAND]
USAGE
  $ vtp COMMAND
...

Commands

• vtp exec
• vtp finalize
• vtp help [COMMAND]
• vtp snapshot SNAPSHOTDIRECTORY

vtp exec

Start and stop Vtp around a supplied command.

USAGE
  $ vtp exec

OPTIONS
  -b, --baseline=baseline                          基线构建
  -p, --port=port                                  [default: 5338] port
  -t, --network-idle-timeout=network-idle-timeout  [default: 50] asset discovery network idle timeout (in milliseconds)

EXAMPLES
  $ vtp exec -- echo "vtp is running around this echo command"
  $ vtp exec -- bash -c "echo foo && echo bar"

See code: dist/commands/exec.ts

vtp finalize

Finalize a build. Commonly used for parallelized builds, especially when the number of parallelized processes is unknown.

USAGE
  $ vtp finalize

OPTIONS
  -a, --all  (required)

EXAMPLE
  $ vtp finalize --all
  [vtp] Finalized parallel build.

See code: dist/commands/finalize.ts

vtp help [COMMAND]

display help for vtp

USAGE
  $ vtp help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

vtp snapshot SNAPSHOTDIRECTORY

Snapshot a directory containing a pre-built static website.

USAGE
  $ vtp snapshot SNAPSHOTDIRECTORY

ARGUMENTS
  SNAPSHOTDIRECTORY  A path to the directory you would like to snapshot

OPTIONS
  -b, --base-url=base-url                          [default: /] If your static files will be hosted in a subdirectory,
                                                   instead
                                                   of the webserver's root path, set that subdirectory with this flag.

  -i, --ignore-files=ignore-files                  Glob or comma-seperated string of globs for matching the files and
                                                   directories to ignore.

  -p, --port=port                                  [default: 5338] Port

  -s, --snapshot-files=snapshot-files              [default: **/*.html,**/*.htm] Glob or comma-seperated string of globs
                                                   for matching the files and directories to snapshot.

  -t, --network-idle-timeout=network-idle-timeout  [default: 50] Asset discovery network idle timeout (in milliseconds)

EXAMPLES
  $ vtp snapshot _site/
  $ vtp snapshot _site/ --base-url "/blog/"
  $ vtp snapshot _site/ --ignore-files "/blog/drafts/**"

See code: dist/commands/snapshot.ts