archive-gh-me/xviz
1
0
Fork 0
mirror of https://github.com/aurora-opensource/xviz.git synced 2026-01-18 14:07:46 +00:00
Code Issues Projects Releases Wiki Activity
xviz/docs/api-reference/server/tools/server-cmds.md
Timothy Wojtaszek 972968687a
@xviz/ros module (#482) 
Support for converter ROS Bag data into XVIZ

Key documents are:
 - RFC ./dev-docs/005-ros-module-rfc.md
 - User Docs ./docs/api-reference/ros
 - Module Readme ./modules/ros/README.md
 - Examples ./examples/converters/ros ./examples/converters/ros-custom
2019-07-02 05:38:00 -04:00

816 B
Raw Permalink Blame History

CLI Command

It is useful to be able to build custom command line tools configured for your data. Below we describe functions than can help with this for the XVIZ server.

Specifically it is useful to register a custom Provider with the XVIZProviderFactory to setup any customizations before the command is executed.

serverArgs(inArgs, options)

Registers the server command and supported options.

Parameters:

  • inArgs (yargs) - The yargs instance that the options and command will be register
  • options.defaultCommand (Boolean) - Option to make this command the default command (default: false)
serverCmd(args)

Executes the server based on supplied arguments.

Parameters:

  • args (Object) - The object containing the parsed arguments