Skip to content

[cli-ref] Fix table spacing and better syntax #738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 31, 2022
Merged

[cli-ref] Fix table spacing and better syntax #738

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4e2b19
[cli-ref] Fix table spacing and better syntax
black-dragon74 May 30, 2022
b78f6cc
Revert formatting on volume commands
black-dragon74 May 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions docs/CLI-Reference/cli-main.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,29 @@

### Overview

Use the Gluster CLI to setup and manage your Gluster cluster from a terminal.
You can run the Gluster CLI on any Gluster server either by invoking the commands
or by running the Gluster CLI in interactive mode.
Use the Gluster CLI to setup and manage your Gluster cluster from a terminal.
You can run the Gluster CLI on any Gluster server either by invoking the commands
or by running the Gluster CLI in interactive mode.
You can also use the gluster command remotely using SSH.

The gluster CLI syntax is `gluster <command>`.


To run a command directly:

```console
# gluster <command>
gluster <command>
```

For example, to view the status of all peers:

```console
# gluster peer status
gluster peer status
```

To run a command in interactive mode, start a gluster shell by typing:

```console
# gluster
gluster
```

This will open a gluster command prompt. You now run the command at the prompt.
Expand All @@ -44,13 +43,12 @@ gluster> peer status

The peer commands are used to manage the Trusted Server Pool (TSP).


| Command | Syntax | Description |
| --------------- |:-----------------------|:------------------------|
| peer probe | peer probe _server_ | Add _server_ to the TSP |
| peer detach | peer detach _server_ | Remove _server_ from the TSP |
| peer status | peer status | Display the status of all nodes in the TSP |
| pool list | pool list | List all nodes in the TSP |
| Command | Syntax | Description |
| ----------- | :------------------- | :----------------------------------------- |
| peer probe | peer probe _server_ | Add _server_ to the TSP |
| peer detach | peer detach _server_ | Remove _server_ from the TSP |
| peer status | peer status | Display the status of all nodes in the TSP |
| pool list | pool list | List all nodes in the TSP |

#### Volume Commands

Expand Down