Skip to main content

spark help

The first argument in the AMPS spark CLI command line is the command for AMPS spark CLI to run. Each command has required and optional arguments.

Run spark help to list supported commands, or spark help <command> to display usage and options for a specific command.

For example, if you want to see options for the publish command in AMPS spark CLI, the following would display the help screen for the AMPS spark CLI's publish feature.

%>./spark help publish

===============================
- Spark - AMPS client utility -
===============================
Usage:

spark publish [options]

Required Parameters:

server -- AMPS server to connect to.

If your server requires a username/password for authentication,
supply them here, for example:
-server user@server:port or
-server user:password@server:port

Spark will interactively prompt for a password if one is not supplied.

topic -- topic to publish to.

Options:

authenticator -- Custom AMPS authenticator factory to use.
delimiter -- decimal value of message separator character (default 10).
Using a zip file (as produced by amps_sow_dump -z) with the -file option
over use of a delimiter.

... further text omitted ...

More information on each command is in this guide, or available through the AMPS spark CLI help text.