README
worldnet-cli
Worldnet's Command-Line Interface Tool.
Usage
$ npm install -g worldnet-cli
$ wn COMMAND
running command...
$ wn (-v|--version|version)
worldnet-cli/4.0.0 linux-x64 node-v16.14.0
$ wn --help [COMMAND]
USAGE
$ wn COMMAND
...
Commands
wn autocomplete [SHELL]
wn config:edit
wn config:get
wn config:init
wn db:create
wn db:drop [SCHEMA]
wn db:dump [SCHEMA]
wn gateway:checkout BRANCH
wn gateway:deploy [BRANCH]
wn gateway:redeploy [BRANCH]
wn gateway:setup [BRANCH]
wn help [COMMAND]
wn run [BRANCH]
wn svn:branch BRANCH
wn svn:checkout BRANCH
wn svn:lock [BRANCH]
wn svn:merge SOURCE
wn svn:revert REV
wn tail
wn tail:app
wn tail:metrics
wn tail:server
wn update [CHANNEL]
wn autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ wn autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ wn autocomplete
$ wn autocomplete bash
$ wn autocomplete zsh
$ wn autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
wn config:edit
Opens dev's configuration for edition
USAGE
$ wn config:edit
DESCRIPTION
Opens dev's configuration for edition
See code: src/commands/config/edit.ts
wn config:get
Prints dev's current configuration
USAGE
$ wn config:get
DESCRIPTION
Prints dev's current configuration
EXAMPLE
$ wn config:get
See code: src/commands/config/get.ts
wn config:init
Initialise wn tool with developer's environment information
USAGE
$ wn config:init
DESCRIPTION
Initialise wn tool with developer's environment information
ALIASES
$ wn init
See code: src/commands/config/init.ts
wn db:create
Creates a database schema from an existing one
USAGE
$ wn db:create
OPTIONS
-d, --schema=schema Database schema to be created
-f, --dump=dump Use a dump file located in your host management folder.
-q, --quiet Execute in silent mode
-t, --template=template Template database schema
DESCRIPTION
Creates a database schema from an existing one
EXAMPLES
$ wn db:create
$ wn db:create -d VERSION_5_8_0_0
$ wn db:create -f wn_nettraxion_init.sql
See code: src/commands/db/create.ts
wn db:drop [SCHEMA]
Drops a database schema
USAGE
$ wn db:drop [SCHEMA]
DESCRIPTION
Drops a database schema
EXAMPLES
$ wn db:drop
$ wn db:drop SCHEMA
See code: src/commands/db/drop.ts
wn db:dump [SCHEMA]
Creates a dump file from a given database schema
USAGE
$ wn db:dump [SCHEMA]
OPTIONS
-q, --quiet Execute in silent mode
DESCRIPTION
Creates a dump file from a given database schema
EXAMPLE
$ wn db:dump SCHEMA
See code: src/commands/db/dump.ts
wn gateway:checkout BRANCH
Checks out a working copy of Net Traxion Gateway from the SVN repository.
USAGE
$ wn gateway:checkout BRANCH
OPTIONS
-q, --quiet Execute in silent mode
DESCRIPTION
Checks out a working copy of Net Traxion Gateway from the SVN repository.
ALIASES
$ wn gateway:co
EXAMPLE
$ wn gateway:checkout VERSION_5_8_0_0
See code: src/commands/gateway/checkout.ts
wn gateway:deploy [BRANCH]
Deploys a given Net Traxion branch to wildfly
USAGE
$ wn gateway:deploy [BRANCH]
OPTIONS
-k, --skipTests Skip unit tests execution
-q, --quiet Execute in silent mode
DESCRIPTION
Deploys a given Net Traxion branch to wildfly
ALIASES
$ wn deploy
EXAMPLE
$ wn gateway:deploy
See code: src/commands/gateway/deploy.ts
wn gateway:redeploy [BRANCH]
Re-deploys an up and running Net Traxion branch
USAGE
$ wn gateway:redeploy [BRANCH]
OPTIONS
-k, --skipTests Skip unit tests execution
-q, --quiet Execute in silent mode
DESCRIPTION
Re-deploys an up and running Net Traxion branch
ALIASES
$ wn redeploy
EXAMPLE
$ wn gateway:redeploy
See code: src/commands/gateway/redeploy.ts
wn gateway:setup [BRANCH]
Sets up a given Net Traxion branch with IDE-related files
USAGE
$ wn gateway:setup [BRANCH]
DESCRIPTION
Sets up a given Net Traxion branch with IDE-related files
ALIASES
$ wn setup
EXAMPLE
$ wn gateway:setup
See code: src/commands/gateway/setup.ts
wn help [COMMAND]
display help for wn
USAGE
$ wn help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
wn run [BRANCH]
executes the whole process from checkout to deploy in order to have a branch up and running
USAGE
$ wn run [BRANCH]
OPTIONS
-d, --schema=schema Database Schema
-q, --quiet Execute in silent mode
--dry Execute checkout and project setup only
DESCRIPTION
Performs the following steps to have the given nettraxion version up and running:
1. Checks out branch from SVN or Git (yet to be supported) repository
2. Creates or points to an existing database schema
3. Sets up the project for the developer's IDE
4. Deploys application into wildfly
EXAMPLE
$ wn run VERSION_5_8_0_0
See code: src/commands/run.ts
wn svn:branch BRANCH
Creates a new branch off the head of an existing one
USAGE
$ wn svn:branch BRANCH
OPTIONS
-q, --quiet Execute in silent mode
-s, --source=source Source branch whose HEAD will be used to create the new one
DESCRIPTION
Creates a new branch off the head of an existing one
EXAMPLE
$ wn svn:branch VERSION_5_9_0_0
See code: src/commands/svn/branch.ts
wn svn:checkout BRANCH
Checks out a working copy from the SVN repository.
USAGE
$ wn svn:checkout BRANCH
OPTIONS
-p, --project=gateway|simulator (required) [default: gateway] Project to checkout
-q, --quiet Execute in silent mode
DESCRIPTION
Checks out a working copy from the SVN repository.
ALIASES
$ wn svn:co
EXAMPLE
$ wn svn:checkout VERSION_5_8_0_0
See code: src/commands/svn/checkout.ts
wn svn:lock [BRANCH]
Closes the redmine version which will trigger a hook that automatically locks the respective branch
USAGE
$ wn svn:lock [BRANCH]
DESCRIPTION
Closes the redmine version which will trigger a hook that automatically locks the respective branch
EXAMPLES
$ wn svn:lock
$ wn svn:lock R_5_9_0_0
See code: src/commands/svn/lock.ts
wn svn:merge SOURCE
Merge changes into a working copy
USAGE
$ wn svn:merge SOURCE
OPTIONS
-f, --force Force merging even to a dirty copy
-q, --quiet Execute in silent mode
-r, --revsOnly Only shows the eligible revisions
-t, --target=target Target branch to which the changes will be applied
DESCRIPTION
Merge changes into a working copy
EXAMPLE
$ wn svn:merge VERSION_5_9_0_0
See code: src/commands/svn/merge.ts
wn svn:revert REV
Allows to revert a specific revision from the current branch
USAGE
$ wn svn:revert REV
OPTIONS
-f, --force Force revert even from a dirty copy
-q, --quiet Execute in silent mode
DESCRIPTION
Allows to revert a specific revision from the current branch
ALIASES
$ wn revert
EXAMPLE
$ wn svn:revert 1986
See code: src/commands/svn/revert.ts
wn tail
contains the commands used to tail application and server logs
USAGE
$ wn tail
See code: src/commands/tail/index.ts
wn tail:app
Tails the application logs (nettraxion.log)
USAGE
$ wn tail:app
OPTIONS
-n, --lines=lines outputs the last NUM lines
DESCRIPTION
Tails the application logs (nettraxion.log)
ALIASES
$ wn tail
EXAMPLE
$ wn tail:app
See code: src/commands/tail/app.ts
wn tail:metrics
Tails the application metrics logs (metrics.log)
USAGE
$ wn tail:metrics
OPTIONS
-n, --lines=lines outputs the last NUM lines
DESCRIPTION
Tails the application metrics logs (metrics.log)
EXAMPLE
$ wn tail:metrics
See code: src/commands/tail/metrics.ts
wn tail:server
Tails the server logs (server.log)
USAGE
$ wn tail:server
OPTIONS
-n, --lines=lines outputs the last NUM lines
DESCRIPTION
Tails the server logs (server.log)
EXAMPLE
$ wn tail:server
See code: src/commands/tail/server.ts
wn update [CHANNEL]
update the wn CLI
USAGE
$ wn update [CHANNEL]
OPTIONS
-a, --available Install a specific version.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=version Install a specific version.
--force Force a re-download of the requested version.
EXAMPLES
[object Object]
[object Object]
[object Object]
[object Object]
See code: @oclif/plugin-update