Documentation on cli frontend not up-to-date

[rmetzger]

I think you don't have to specify the "run" command anymore:

http://stratosphere.eu/docs/0.5/program_execution/cli_client.html

[rmetzger]

I think the output now is

./bin/stratosphere
Please specify an action.
./stratosphere <ACTION> [GENERAL_OPTIONS] [ARGUMENTS]
  general options:
     -h,--help      Show the help for the CLI Frontend.
     -v,--verbose   Print more detailed error messages.

Action "run" compiles and runs a program.

  Syntax: run [OPTIONS] <jar-file> <arguments>
  "run" action arguments:
     -c,--class <classname>           Class with the program entry point ("main"
                                      method or "getPlan()" method. Only needed
                                      if the JAR file does not specify the class
                                      in its manifest.
     -m,--jobmanager <host:port>      Address of the JobManager (master) to
                                      which to connect. Use this flag to connect
                                      to a different JobManager than the one
                                      specified in the configuration.
     -p,--parallelism <parallelism>   The parallelism with which to run the
                                      program. Optional flag to override the
                                      default value specified in the
                                      configuration.

Action "info" displays information about a program.
  "info" action arguments:
     -c,--class <classname>           Class with the program entry point ("main"
                                      method or "getPlan()" method. Only needed
                                      if the JAR file does not specify the class
                                      in its manifest.
     -d,--description                 Show description of expected program
                                      arguments
     -e,--executionplan               Show optimized execution plan of the
                                      program (JSON)
     -m,--jobmanager <host:port>      Address of the JobManager (master) to
                                      which to connect. Use this flag to connect
                                      to a different JobManager than the one
                                      specified in the configuration.
     -p,--parallelism <parallelism>   The parallelism with which to run the
                                      program. Optional flag to override the
                                      default value specified in the
                                      configuration.

Action "list" lists running and finished programs.
  "list" action arguments:
     -m,--jobmanager <host:port>   Address of the JobManager (master) to which
                                   to connect. Use this flag to connect to a
                                   different JobManager than the one specified
                                   in the configuration.
     -r,--running                  Show running programs and their JobIDs
     -s,--scheduled                Show scheduled prorgrams and their JobIDs

Action "cancel" cancels a running program.
  "cancel" action arguments:
     -i,--jobid <jobID>            JobID of program to cancel
     -m,--jobmanager <host:port>   Address of the JobManager (master) to which
                                   to connect. Use this flag to connect to a
                                   different JobManager than the one specified
                                   in the configuration.

[StephanEwen]

You still have to specify run.

The shortest possible command is "bin/stratosphere run /home/me/program.jar"

[rmetzger]

Ah, ok. But still, the documentation is not in sync

[StephanEwen]

What is not in sync? It is not a simple copy of the help output, but it
adds some information. Flags and arguments and all are in sync, no?

[rmetzger]

Ah, okay. I though everything in the grey box is copy pasted from the output.

What I'm missing in the grey box is the following line Syntax: run [OPTIONS] <jar-file> <arguments>.
But you are right, if you closely read the text, you can find it:

  "run" arguments:

     - The first argument is the path to the JAR file of the program.
     - All successive arguments are passed to the program's main method (or getPlan() method).