This is an automated email from the ASF dual-hosted git repository.
agura pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
The following commit(s) were added to refs/heads/main by this push:
new 483af7884 IGNITE-17073 CLI getting started guide update
483af7884 is described below
commit 483af7884521fb8031448221d37b79a47d634401
Author: IgGusev <[email protected]>
AuthorDate: Tue Jun 7 18:45:29 2022 +0300
IGNITE-17073 CLI getting started guide update
Signed-off-by: Andrey Gura <[email protected]>
---
docs/_docs/ignite-cli-tool.adoc | 84 ++++++++++++++++++-----
docs/_docs/quick-start/getting-started-guide.adoc | 30 +-------
2 files changed, 69 insertions(+), 45 deletions(-)
diff --git a/docs/_docs/ignite-cli-tool.adoc b/docs/_docs/ignite-cli-tool.adoc
index 8b155a455..9c7993a6b 100644
--- a/docs/_docs/ignite-cli-tool.adoc
+++ b/docs/_docs/ignite-cli-tool.adoc
@@ -13,27 +13,77 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-== Ignite CLI Tool
+= Ignite CLI Tool
The Ignite CLI tool uses REST API as a communication protocol between the node
and the CLI,
-allowing you to configure the node.
+allowing you to configure the node. By default, the CLI tool runs in the REPL
(Read Eval Print Loop) mode, but you can also execute commands without entering
it.
Below is a list of Ignite CLI tool commands with short descriptions:
-[cols="1,3",opts="header", stripes=none]
+== Installation and Usage
+
+You can find detailed installation guide in the
link:quick-start/getting-started-guide[Getting Started] tutorial. The tutorial
also includes some basic usage examples.
+
+== Command Options
+
+The following commands can be executed in REPL mode of the command line tool:
+
+[cols="1,1,3",opts="header", stripes=none]
+|===
+| Command| Parameters | Description
+| `bootsrap` || Installs Ignite core modules locally. Previously `init`.
+| `clear` || Clears the terminal.
+| `cli config` || Gets all CLI tool configuration values.
+| `cli config get` | `<config key-value>` | Gets the value of the specified
CLI tool configuration.
+| `cli config set` | `<config key-value>` | Sets the value of the specified
CLI tool configuration.
+| `cluster init` | `[--cluster-url] <--meta-storage-node> [--cmg-node]`|
Initializes the cluster on the specified URL.
+| `cluster show` | `[--cluster-url]` | Displays the detailed status of the
specified cluster.
+| `cluster config show` | `[--cluster-url] [--selector]` | Gets the
configuration of the specified cluster.
+| `cluster config update` | `[--cluster-url] <config in HOCON format>` |
Updates the configuration of the cluster with the provided configuration in
HOCON format.
+| `connect` | [--cluster-url] | Connects to the specified cluster, or
`localhost:3000` if no cluster url is specified. All subsequent commands use
the specified cluster url.
+| `disconnect` || Disconnects from the cluster.
+| `exit` || Stops current interactive session.
+| `help` | `<command>` | Provides information on available commands, or for
specific command if the `command` parameter is specified.
+| `node classpath` || Shows the current classpath used by Ignite nodes.
+| `node config show` | `[--node-url][--selector]` | Gets the local node
configuration.
+|`node config update` | `[--node-url] <config in HOCON format>` | Updates the
local node configuration with the provided configuration in HOCON format.
+| `node list` || Shows the list of currently running local Ignite nodes.
+| `node start` | `[--config] <nodeName>` | Starts an Ignite node locally.
+| `node stop` | `<nodeName>` | Stops a locally running Ignite node.
+| `status` | `--cluster-url` |Shows the status of the default cluster, or a
different one if cluster-url is provided.
+| `sql` | `[--cluster-url][--script-file] <query>` | Executes the specified
SQL query.
+| `version` || Displays current CLI tool version.
+
+
+
+
+
+
|===
-| Command | Description
-| `config` | Inspects and updates Ignite cluster configuration.
-| `config get` | Gets current Ignite cluster configuration values.
-| `config set` | Updates Ignite cluster configuration values.
-| `init` | Installs Ignite core modules locally.
-| `module` | Manages optional Ignite modules and external artifacts.
-| `module list` | Shows the list of available optional Ignite modules.
-| `module add` | Adds an optional Ignite module or an external artifact.
-| `module remove` | Adds an optional Ignite module or an external artifact.
-| `node`| Starts, stops, and manages locally running Ignite nodes.
-| `node start` | Starts an Ignite node locally.
-| `node stop` | Stops a locally running Ignite node.
-| `node classpath` | Shows the current classpath used by the Ignite nodes.
-| `node list` | Shows the list of currently running local Ignite nodes.
+
+== Non-interactive Mode
+
+The following commands can be executed in non-REPL mode of the command-line
tool:
+
+[cols="1,1,3",opts="header", stripes=none]
|===
+| Command| Parameters | Description
+| `ignite cli config` || Gets all CLI tool configuration values.
+| `ignite cli config get` | `<config key-value>` | Gets the value of the
specified CLI tool configuration.
+| `ignite cli config set` | `<config key-value>` | Sets the value of the
specified CLI tool configuration.
+| `ignite bootsrap` || Installs Ignite core modules locally. Previously `init`.
+| `ignite cluster config show` | `[--cluster-url] [--selector]` | Gets the
configuration of the specified cluster.
+| `ignite cluster config update` | `[--cluster-url] <config in HOCON format>`
| Sets the configuration of the cluster with the provided configuration in
HOCON format.
+| `ignite cluster init` | `[--cluster-url] <--meta-storage-node>
[--cmg-node]`| Initializes the cluster on the specified URL.
+| `ignite cluster show` | `[--cluster-url]` | Displays the detailed status of
the specified cluster.
+| `ignite help` | `<command>` | Provides information on available commands, or
for specific command if the `command` parameter is specified.
+| `ignite node classpath` || Shows the current classpath used by Ignite nodes.
+| `ignite node config show` | `[--node-url][--selector]` | Gets the local node
configuration.
+| `ignite node list` || Shows the list of currently running local Ignite nodes.
+| `ignite node start` | `[--config] <nodeName>` | Starts an Ignite node
locally.
+| `ignite node stop` | `<nodeName>` | Stops a locally running Ignite node.
+|`ignite node config update` | `[--node-url] <config in HOCON format>` |
Updates the local node configuration with the provided configuration in HOCON
format.
+| `ignite status` | `--cluster-url` |Shows the status of the default cluster,
or a different one if cluster-url is provided.
+| `ignite sql` | `[--cluster-url][--script-file] <query>` | Executes the
specified SQL query.
+| `ignite version` || Displays current CLI tool version.
+|===
\ No newline at end of file
diff --git a/docs/_docs/quick-start/getting-started-guide.adoc
b/docs/_docs/quick-start/getting-started-guide.adoc
index 961954667..58c3ffc5d 100644
--- a/docs/_docs/quick-start/getting-started-guide.adoc
+++ b/docs/_docs/quick-start/getting-started-guide.adoc
@@ -86,7 +86,7 @@ tar -xf apache-ignite-3.0.0-alpha4.zip & cd
apache-ignite-3.0.0-alpha4
tab:Unix[]
[source,shell]
----
-echo 'export PATH="'`pwd`':$PATH"' >> ~/.bash_profile && source ~/.bash_profile
+echo 'export PATH="'`pwd`':$PATH"' >> ~/.bash_profile && source
~/.bash_profile && source ignite_completion.sh
----
tab:Windows (PowerShell)[]
@@ -128,35 +128,9 @@ ignite
+
[source, shell]
----
-ignite init --help
+ignite bootstrap --help
----
-== Installing Ignite Artifacts and Dependencies
-
-Ignite CLI allows to install Ignite modules and 3rd party Maven dependencies.
-
-WARNING: If you have installed one of the Ignite 3 Alpha releases before,
please remove the `~/.ignitecfg` file before proceeding. This is a temporary
step, the procedure will be improved in the future releases.
-
-. To start an Ignite 3.0 Alpha 4 cluster, you need to install Ignite core
artifacts first:
-+
-[source, shell]
-----
-ignite init
-----
-
-. Use the `module add` command to download Guava from Maven and add it to the
Ignite classpath:
-+
-[source, shell]
-----
-ignite module add mvn:com.google.guava:guava:23.0
-----
-
-. Confirm the library is added to the Ignite dependencies list:
-+
-[source, shell]
-----
-ignite module list
-----
== Starting a Node
