README
WarpFleet cli
Prerequisits
- NodeJS
Installation
$ yarn install
$ yarn deploy
Usage
$ wf
___ __ _______________ _____
__ | / /_____ __________________ ____/__ /___________ /_
__ | /| / /_ __ `/_ ___/__ __ \_ /_ __ /_ _ \ _ \ __/
__ |/ |/ / / /_/ /_ / __ /_/ / __/ _ / / __/ __/ /_
____/|__/ \__,_/ /_/ _ .___//_/ /_/ \___/\___/\__/
/_/ ™
Usage: wf [options] [command]
WarpFleet Command Line Interface
Options:
-v, --version output the version number
--debug Debug mode
-h, --help output usage information
Commands:
init|i [options] Initialize a new Project
list|l [group] [artifact] List available artifact and/or versions
info <group> <artifact> [version] Get information about a specific artifact
install [options] [wfFile] Install your dependencies into your Warp 10
get|g [options] <group> [artifact] [version] Retrieve the packed macros, plugin or extension archive. If no version is specified, the most recent one is retrieved.
publish|p [options] [version] [path] [repoUrl] Publishes a plugin, macro or extension against WarpFleet
unpublish|u [options] [version] [path] [repoUrl] Unpublishes a plugin, macro or extension against WarpFleet
Init
$ wf init --help
Usage: init|i [options]
Initialize a new Project
Options:
-w, --wf Generate only wf.json
-h, --help output usage information
List
$ wf list --help
Usage: list|l [options] [group] [artifact]
List available artifact and/or versions
Options:
-h, --help output usage information
Info
$ wf info --help
Usage: info [options] <group> <artifact> [version]
Get information about a specific artifact
Options:
-h, --help output usage information
Install
$ wf install --help
Usage: install [options] [wfFile]
Install your dependencies into your Warp 10
Options:
-c, --conf <warp10ConfFile> Warp 10 configuration file path
-d, --confDir <confDir> Warp 10 configuration directory (for Warp 10 >= 2.1.0)
-m, --macroDir <macroPath> Warp 10 macro directory path
-l, --libDir <libPath> Warp 10 lib directory path
-f, --force Force the configuration creation
-h, --help output usage information
Get
$ wf get --help
Usage: get|g [options] <group> [artifact] [version]
Retrieve the packed macros, plugin or extension archive. If no version is specified, the most recent one is retrieved.
Options:
-c, --conf <warp10ConfFile> Warp 10 configuration file path
-d, --confDir <confDir> Warp 10 configuration directory (for Warp 10 >= 2.1.0)
-m, --macroDir <macroPath> Warp 10 macro directory path
-l, --libDir <libPath> Warp 10 lib directory path
-h, --help output usage information
Publish
$ wf publish --help
Usage: publish|p [options] [version] [path] [repoUrl]
Publishes a plugin, macro or extension against WarpFleet
Options:
-g --gpg <gpgKeyId> GPG Key Id
-h, --help output usage information
Unpublish
$ wf unpublish --help
Usage: unpublish|u [options] [version] [path] [repoUrl]
Unpublishes a plugin, macro or extension against WarpFleet
Options:
-g --gpg <gpgKeyId> GPG Key Id
-h, --help output usage information
Generate documentation
$ wf doc --help
Usage: index doc [options] [url] [source] [dest]
Generates documentation files against a Warp 10 instance due to the INFOMODE.
Options:
-o --output <format> Output format (json, html, markdown)
-h, --help display help for command
Sample:
$ wf doc http://localhost:8080 /home/user/warpscript ./doc -o html