> ## Documentation Index
> Fetch the complete documentation index at: https://simplecloud.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Cloud Command

> Use SimpleCloud's in-game proxy commands for groups, servers, and players

## Overview

The Cloud Command plugin adds proxy commands for day-to-day network operations. You can inspect groups and servers, start and stop group servers, move players, and send player messages.

The root command is available as `/cloud`, `/sc`, and `/simplecloud`.

## Supported Software

| Software   | Plugin Support |
| ---------- | -------------- |
| Velocity   | Yes            |
| BungeeCord | Yes            |
| Gate       | Planned        |

## Quick Setup

1. Download the plugin from [GitHub](https://github.com/simplecloudapp/command-plugin/releases).
2. Place it in your proxy template's `plugins/` folder.
3. Make sure the `simplecloud-api` plugin is installed on the proxy.
4. Start the proxy once to generate the message configuration.

## Commands

### Groups

| Command                              | Description                                                     |
| ------------------------------------ | --------------------------------------------------------------- |
| `/cloud group list`                  | List all groups                                                 |
| `/cloud group info <group>`          | Show group type, memory, player limit, and running server count |
| `/cloud group start <group> [count]` | Request one or more new servers for a group                     |
| `/cloud group stop <group> [id]`     | Stop all running servers in a group, or one numerical ID        |

### Servers

| Command                           | Description                                        |
| --------------------------------- | -------------------------------------------------- |
| `/cloud server list [group]`      | List running servers, optionally filtered by group |
| `/cloud server info <group> <id>` | Show state, memory, and players for one server     |
| `/cloud server start <group>`     | Request one new server for a group                 |
| `/cloud server stop <group> <id>` | Stop one running server                            |

### Players

Use `group` for a server group target and `ps` for a persistent server target.

| Command                                                | Description                                     |
| ------------------------------------------------------ | ----------------------------------------------- |
| `/cloud player list <group\|ps> <target>`              | List players on a group or persistent server    |
| `/cloud player info <player>`                          | Show player connection details                  |
| `/cloud player send <player> <group\|ps> <target>`     | Send one player to a target                     |
| `/cloud player sendall <group\|ps> <target>`           | Send every online player to a target            |
| `/cloud player sendfrom <source> <group\|ps> <target>` | Send players from one source server to a target |
| `/cloud player message <player> <message>`             | Send a plain text message to a player           |

### Reload

| Command         | Description                             |
| --------------- | --------------------------------------- |
| `/cloud reload` | Run the command plugin's reload command |

## Permissions

| Permission                           | Description                                         |
| ------------------------------------ | --------------------------------------------------- |
| `simplecloud.command.use`            | Use the root command and view available subcommands |
| `simplecloud.command.group.list`     | Use `/cloud group list`                             |
| `simplecloud.command.group.info`     | Use `/cloud group info`                             |
| `simplecloud.command.group.start`    | Use `/cloud group start`                            |
| `simplecloud.command.group.stop`     | Use `/cloud group stop`                             |
| `simplecloud.command.server.list`    | Use `/cloud server list`                            |
| `simplecloud.command.server.info`    | Use `/cloud server info`                            |
| `simplecloud.command.server.start`   | Use `/cloud server start`                           |
| `simplecloud.command.server.stop`    | Use `/cloud server stop`                            |
| `simplecloud.command.player.list`    | Use `/cloud player list`                            |
| `simplecloud.command.player.info`    | Use `/cloud player info`                            |
| `simplecloud.command.player.send`    | Use player transfer commands                        |
| `simplecloud.command.player.message` | Use `/cloud player message`                         |
| `simplecloud.command.reload`         | Use `/cloud reload`                                 |

<Note>
  The help menu only shows commands for permissions the sender has.
</Note>

<Frame>
  <img src="https://github.com/simplecloudapp/branding/blob/main/media/plugin/cloud-command/help.png?raw=true" alt="Cloud Command help menu" />
</Frame>