Skip to content

Commit

Permalink
Formatting for CLI start (#1135)
Browse files Browse the repository at this point in the history
  • Loading branch information
joel-hamill authored Apr 13, 2018
1 parent 527357f commit 8389e3a
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 38 deletions.
12 changes: 6 additions & 6 deletions docs/includes/ksql-includes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,15 @@ Launch the KSQL CLI
To launch the CLI, run the following command. It will route the CLI logs to the ``./ksql_logs`` directory. By default,
the CLI will look for a KSQL Server running at ``http://localhost:8088``.
.. code:: bash
.. code:: bash
$ LOG_DIR=./ksql_logs <path-to-confluent>/bin/ksql
$ LOG_DIR=./ksql_logs <path-to-confluent>/bin/ksql
After KSQL is started, your terminal should resemble this.
After KSQL is started, your terminal should resemble this.
.. include:: ../includes/ksql-includes.rst
:start-line: 19
:end-line: 40
.. include:: ../includes/ksql-includes.rst
:start-line: 19
:end-line: 40
.. _create-a-stream-and-table:
Expand Down
64 changes: 32 additions & 32 deletions docs/installation/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,52 +122,52 @@ After KSQL is started, your terminal should resemble this.
Tip
You can view the KSQL CLI help text by running ``<path-to-confluent>/bin/ksql --help``.

.. code:: bash
.. code:: bash
NAME
ksql - KSQL CLI
NAME
ksql - KSQL CLI
SYNOPSIS
ksql [ --config-file <configFile> ] [ {-h | --help} ]
[ --output <outputFormat> ]
[ --query-row-limit <streamedQueryRowLimit> ]
[ --query-timeout <streamedQueryTimeoutMs> ] [--] <server>
SYNOPSIS
ksql [ --config-file <configFile> ] [ {-h | --help} ]
[ --output <outputFormat> ]
[ --query-row-limit <streamedQueryRowLimit> ]
[ --query-timeout <streamedQueryTimeoutMs> ] [--] <server>
OPTIONS
--config-file <configFile>
A file specifying configs for Ksql and its underlying Kafka Streams
instance(s). Refer to KSQL documentation for a list of available
configs.
OPTIONS
--config-file <configFile>
A file specifying configs for Ksql and its underlying Kafka Streams
instance(s). Refer to KSQL documentation for a list of available
configs.
-h, --help
Display help information
-h, --help
Display help information
--output <outputFormat>
The output format to use (either 'JSON' or 'TABULAR'; can be changed
during REPL as well; defaults to TABULAR)
--output <outputFormat>
The output format to use (either 'JSON' or 'TABULAR'; can be changed
during REPL as well; defaults to TABULAR)
--query-row-limit <streamedQueryRowLimit>
An optional maximum number of rows to read from streamed queries
--query-row-limit <streamedQueryRowLimit>
An optional maximum number of rows to read from streamed queries
This options value must fall in the following range: value >= 1
This options value must fall in the following range: value >= 1
--query-timeout <streamedQueryTimeoutMs>
An optional time limit (in milliseconds) for streamed queries
--query-timeout <streamedQueryTimeoutMs>
An optional time limit (in milliseconds) for streamed queries
This options value must fall in the following range: value >= 1
This options value must fall in the following range: value >= 1
--
This option can be used to separate command-line options from the
list of arguments (useful when arguments might be mistaken for
command-line options)
--
This option can be used to separate command-line options from the
list of arguments (useful when arguments might be mistaken for
command-line options)
<server>
The address of the Ksql server to connect to (ex:
http://confluent.io:9098)
<server>
The address of the Ksql server to connect to (ex:
http://confluent.io:9098)
This option may occur a maximum of 1 times
This option may occur a maximum of 1 times
-----------------------------
Expand Down

0 comments on commit 8389e3a

Please sign in to comment.