| --- |
| title: gfsh |
| --- |
| |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| |
| `gfsh` (pronounced "jee-fish") provides a single, powerful command-line interface from which you can launch, manage, and monitor <%=vars.product_name%> processes, data, and applications. |
| |
| - **[What You Can Do with gfsh](about_gfsh.html)** |
| |
| `gfsh` supports the administration, debugging, and deployment of <%=vars.product_name_long%> processes and applications. |
| |
| - **[Starting gfsh](starting_gfsh.html)** |
| |
| Before you start `gfsh`, confirm that you have set JAVA\_HOME and that your PATH variable includes the `gfsh` executable. |
| |
| - **[Configuring the gfsh Environment](configuring_gfsh.html)** |
| |
| The `gfsh.bat` and `gfsh` bash script automatically append the required <%=vars.product_name_long%> and JDK .jar libraries to your existing CLASSPATH. There are user-configurable properties you can set for security, environment variables, logging, and troubleshooting. |
| |
| - **[Useful gfsh Shell Variables](useful_gfsh_shell_variables.html)** |
| |
| You can use the built-in `gfsh` shell variables in scripts. |
| |
| - **[Basic Shell Features and Command-Line Usage](getting_started_gfsh.html)** |
| |
| The `gfsh` utility provides useful features for a shell environment, including command auto-complete, preserved command history, and delimiting of multi-line commands. Context-sensitive help is available by command and by topic. |
| |
| - **[Specifying JSON within Command-Line Options](json_in_gfsh.html)** |
| |
| Some `gfsh` commands allow JSON specifications within command-line options. |
| |
| - **[Tutorial—Performing Common Tasks with gfsh](tour_of_gfsh.html)** |
| |
| This topic takes you through a typical sequence of tasks that you execute after starting `gfsh`. |
| |
| - **[Quick Reference of gfsh Commands by Functional Area](gfsh_quick_reference.html)** |
| |
| This quick reference sorts all commands into functional areas. |
| |
| - **[gfsh Command Help](gfsh_command_index.html)** |
| |
| This section provides help and usage information on all `gfsh` commands, listed alphabetically. |
| |
| - **[Creating and Running gfsh Command Scripts](command_scripting.html)** |
| |
| `gfsh` offers several ways to run commands in a scripting environment. |
| |
| - **[Running gfsh Commands on the OS Command Line](os_command_line_execution.html)** |
| |
| - **[Mapping of cache.xml Elements to gfsh Configuration Commands.](cache_xml_2_gfsh.html)** |
| |
| You can configure a <%=vars.product_name%> cluster using either cache.xml files, or you can use `gfsh` and the cluster configuration service to configure a cluster. This section maps cache.xml elements to the `gfsh` commands that configure and manage a cluster. |
| |
| |