The command-line interface (CLI) to the Adapter provides some helpful commands, including:
- show all available commands (help)
- run the Adapter
- generate a default top-level config file
- generate a default protocol-specific config file for specified profiles
- list all the provided protocol plugins
Prints a short description of all the available commands and parameters.
A default top-level configuration may be generated using the -g flag. This file is needed when running the Adapter (see Running the adapter).
Some plugins, notably the Adapter-type protocol plugins, need extra configuration in separate files. The output file is specified with the -g argument. The plugin for which the config is generated is specified with the -p argument. The desired profile is specified with the -f argument.
Multiple profiles can be generated for a single configuration file by providing multiple -f parameters:
Each YAML configuration file has JSON schemas that can be printed to a file to help with writing valid configurations.
To generate the top-level schema, run the following:
To generate the schema for a particular plugin, run the following:
--pretty-print argument can also be used to produce human-readable schema files. Note that these files are particularly large for plugins and pretty-printing should be used only for debugging purposes.
To learn how to leverage these schemas in your editing environment, see the Schemas page.
The adapter is run using the
-c flag. To stop the adapter, hit Ctrl-C on the keyboard.
All available plugins compiled in this instance of the adapter can be listed using the
git commit date and hash of the code compiled in this instance of the adapter can be listed
-v flag. The hash can be used on GitHub to retrieve the exact code used, simply go to