> For the complete documentation index, see [llms.txt](https://pokecloud.gitbook.io/pokecloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pokecloud.gitbook.io/pokecloud/master/commands.md).

# Commands

List of all available commands

### create-nest

Creates a new public nest using the current servers setting. When creating a nest the amount of pokestops, gyms and spawns can optionally be provided after the nest name by separating each with a comma.

| Category | Permissions | Channel |
| -------- | ----------- | ------- |
| Nests    | Admin Role  | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$create-nest <nest name>, [pokestops], [gyms], [spawns], [exgyms]
```

*KEY: < > required | \[ ] optional*
{% endtab %}

{% tab title="Alias" %}

```
$cn <nest name>, [pokestops], [gyms], [spawns], [exgyms]
```

*KEY: < > required | \[ ] optional*
{% endtab %}

{% tab title="Example" %}

```
$create-nest <hilton park>, 20, 12, 45, 2
```

*Creates a new nest called **Hilton Park** with **20** pokestops, **12** gyms, **45** spawns and **2** ex raid gyms.*
{% endtab %}
{% endtabs %}

### delete-nest

Delete an existing public nest created by this community. A nest can **not** be recovered once deleted.

| Category | Permissions | Channel |
| -------- | ----------- | ------- |
| Nests    | Admin Role  | Admin   |
|          |             | Nest    |

{% tabs %}
{% tab title="Usage" %}

```
$delete-nest <nest name>
```

*KEY: < > = required | \[ ] = optional*
{% endtab %}

{% tab title="Alias" %}

```
$dn <nest name>
```

*KEY: < > required | \[ ] optional*
{% endtab %}

{% tab title="Example" %}

```
$delete-nest hilton park
```

{% endtab %}
{% endtabs %}

### help

Returns a list of all available commands in alphabetical order categorized by the command category. If a command is specific, results return help about a specific command.

| Category  | Permissions | Channel |
| --------- | ----------- | ------- |
| Utilities | Any         | Any     |

{% tabs %}
{% tab title="Usage" %}

```
$help [command]
```

*KEY: < > = required | \[ ] = optional*
{% endtab %}

{% tab title="Alias" %}

```
$h [command]
```

*KEY: < > required | \[ ] optional*
{% endtab %}

{% tab title="Example" %}

```
$help create-nest
```

{% endtab %}
{% endtabs %}

### list-all-nests

Lists all nests created by this community in alphabetical order and allows live reporting and updating.

| Category | Permissions | Channel |
| -------- | ----------- | ------- |
| Nests    | Admin Role  | Nest    |

{% tabs %}
{% tab title="Usage" %}

```
$list-all-nests
```

{% endtab %}

{% tab title="Alias" %}

```
$lan
```

{% endtab %}
{% endtabs %}

### list-nest

List a nest created by this community and allow for live reporting and updating.

| Category | Permissions | Channel |
| -------- | ----------- | ------- |
| Nests    | Admin Role  | Nest    |

{% tabs %}
{% tab title="Usage" %}

```
$list-nest <nest name>
```

{% endtab %}

{% tab title="Alias" %}

```
$ln <nest name>
```

{% endtab %}

{% tab title="Example" %}

```
$list-nest hilton park
```

{% endtab %}
{% endtabs %}

### nests

Displays a search result for nests created by this community along with directions and the nesting species. If the **miscord** server setting is `true` the directions link will be removed.

| Category | Permissions | Channel |
| -------- | ----------- | ------- |
| Nests    | Any         | Any     |

{% tabs %}
{% tab title="Usage" %}

```
$nests
```

{% endtab %}

{% tab title="Alias" %}

```
$n
```

{% endtab %}
{% endtabs %}

### nickname

Changes the nickname of the current user for **the current server only**. Be sure to abid by the servers guidelines.

| Category  | Permissions | Channel |
| --------- | ----------- | ------- |
| Utilities | Any         | Any     |

{% tabs %}
{% tab title="Usage" %}

```
$nickname <nickname here>
```

{% endtab %}

{% tab title="Alias" %}

```
$nick <nickname here>
```

{% endtab %}

{% tab title="Example" %}

```
$nickname AshCatchem
```

{% endtab %}
{% endtabs %}

### set-admin-channel

Set the servers active admin channel. Requires the id of the channel to ensure accuracy.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$set-admin-channel <channel id>
```

{% endtab %}

{% tab title="Alias" %}

```
$sac <channel id>
```

{% endtab %}

{% tab title="Example" %}

```
$set-admin-channel 426114026490415222
```

{% endtab %}
{% endtabs %}

### set-admin-role

Set the servers active admin role.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$set-admin-role <role name>
```

{% endtab %}

{% tab title="Alias" %}

```
$sar <role name>
```

{% endtab %}

{% tab title="Example" %}

```
$set-admin-role Admin Team
```

{% endtab %}
{% endtabs %}

### set-city-channel

Set the servers city channel using the id of the channel. This ensures accuracy and allows you to change the channel name at any time. A city channel is a sub nest channel used to list all nests for one area your server covers (if the server has area based channels).

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% hint style="success" %}
**Accepted Numbers**\
**`1` | `2`**&#x20;
{% endhint %}

{% tabs %}
{% tab title="Usage" %}

```
$set-city-channel <number>, <channel id>
```

{% endtab %}

{% tab title="Alias" %}

```
$scc <number>, <channel id>
```

{% endtab %}

{% tab title="Example" %}

```
$scc 1, 000000000000000000
```

{% endtab %}
{% endtabs %}

### set-city

Set the servers active city. This is used to auto generate data when creating nests and for auto search results.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$set-city <city name>
```

{% endtab %}

{% tab title="Alias" %}

```
$sc <city name>
```

{% endtab %}

{% tab title="Example" %}

```
$set-city roswell
```

{% endtab %}
{% endtabs %}

### set-country

Set the servers active country. This is used to auto generate data when creating nests and for auto search results.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$set-country <country name>
```

{% endtab %}

{% tab title="Alias" %}

```
$scounty <country name>
```

{% endtab %}

{% tab title="Example" %}

```
$set-country usa
```

{% endtab %}
{% endtabs %}

### set-language

Set the servers active language. This will allow for argument and auto response translation.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% hint style="success" %}
**Accepted Arguments:**\
**`english` | `german`**
{% endhint %}

{% tabs %}
{% tab title="Usage" %}

```
$set-language <argument>
```

{% endtab %}

{% tab title="Alias" %}

```
$sl <argument>
```

{% endtab %}

{% tab title="Example" %}

```
$set-language english
```

{% endtab %}
{% endtabs %}

### set-migration-date

Set the servers next migration date using the month and day (The year is automatically generated). This is used to determine if the reported migration is a regular scheduled or event migration.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |
|                 |             | Nest    |

{% tabs %}
{% tab title="Usage" %}

```
$set-migration-date <month>, <day>
```

{% endtab %}

{% tab title="Alias" %}

```
$smd <month>, <day>
```

{% endtab %}

{% tab title="Example" %}

```
$set-migration-date 10, 2
```

{% endtab %}
{% endtabs %}

### set-nest-channel

Set the servers active nest channel. Requires the id of the channel to ensure accuracy.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$set-nest-channel <channel id>
```

{% endtab %}

{% tab title="Alias" %}

```
$snc <channel id>
```

{% endtab %}

{% tab title="Example" %}

```
$set-nest-channel 426114026490415222
```

{% endtab %}
{% endtabs %}

### set-nest-role

Set the servers active nest manager role.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$set-nest-role <role name>
```

{% endtab %}

{% tab title="Alias" %}

```
$snr <role name>
```

{% endtab %}

{% tab title="Example" %}

```
$set-nest-role Nest Manager
```

{% endtab %}
{% endtabs %}

### set-prefix

Set the servers active prefix. This is what allows the bot to read the message for a command.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$set-prefix <new prefix>
```

{% endtab %}

{% tab title="Alias" %}

```
$sp <new prefix>
```

{% endtab %}

{% tab title="Example" %}

```
$set-prefix !
```

{% endtab %}
{% endtabs %}

### set-region

Set the servers active region/nickname/statewide capital. This is used to auto generate data when creating nests and for auto search results.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$set-region <region name>
```

{% endtab %}

{% tab title="Alias" %}

```
$sr <region name>
```

{% endtab %}

{% tab title="Example" %}

```
$set-region atlanta
```

{% endtab %}
{% endtabs %}

### set-state

Set the servers active state. This is used to auto generate data when creating nests and for auto search results.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$set-state <state name>
```

{% endtab %}

{% tab title="Alias" %}

```
$ss <state name>
```

{% endtab %}

{% tab title="Example" %}

```
$set-state georgia
```

{% endtab %}
{% endtabs %}

### report-migration

Sets all nests created by the current server to unreported. All nests listed in the nest channel will update live and search results will be updated for the next search. The current nesting species will also be saved in case of a nest revert. This command also edits the migration details message listed in the nest channel to the proper dates.

| Category  | Permissions | Channel |
| --------- | ----------- | ------- |
| Migration | Admin       | Admin   |
|           |             | Nest    |

{% tabs %}
{% tab title="Usage" %}

```
$report-migration
```

{% endtab %}

{% tab title="Alias" %}

```
$rmigration
```

{% endtab %}
{% endtabs %}

### set-timezone

Set the servers active timezone. This is used to auto generate data used for nest migrations.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% hint style="success" %}
**USA Arguments**\
**`central` | `eastern` | `mountain` | `pacific`**
{% endhint %}

{% hint style="success" %}
**UTC Arguments**\
&#x20;**`utc0` |`utc1` | `utc2` | `utc10`**
{% endhint %}

{% tabs %}
{% tab title="Full Command" %}

```
$set-timezone <argument>
```

{% endtab %}

{% tab title="Alias" %}

```
$stz <argument>
```

{% endtab %}

{% tab title="Example" %}

#### US Example:

```
$stz eastern
```

#### UTC Example:

```
$stz utc-3
$stz utc5
```

{% endtab %}
{% endtabs %}

### toggle-miscord

If true, PokeCloud will display specific command responses differently to best fit Facebook Messenger. If false, PokeCloud will display command responses best fit for Discord.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$toggle-miscord
```

{% endtab %}

{% tab title="Alias" %}

```
$tmiscord
```

{% endtab %}
{% endtabs %}

### toggle-migration-tag

If true, PokeCloud will send a message in the set channel tagging the set role about the report migration.

| Category        | Permissions | Channel |
| --------------- | ----------- | ------- |
| Server Settings | Admin       | Admin   |

{% tabs %}
{% tab title="Usage" %}

```
$toggle-migration-tag
```

{% endtab %}

{% tab title="Alias" %}

```
$tmt
```

{% endtab %}
{% endtabs %}

### report-nest

Report a Pokemon nesting at a nest created by the current community.

| Category | Permissions       | Channel |
| -------- | ----------------- | ------- |
| Nests    | Admin Role        | Admin   |
|          | Nest Manager Role | Nest    |

{% tabs %}
{% tab title="Usage" %}

```
$report-nest <nest name>, <pokemon>
```

*KEY: < > = required | \[ ] = optional*
{% endtab %}

{% tab title="Alias" %}

```
$rn <nest name>, <pokemon>
```

*KEY: < > required | \[ ] optional*
{% endtab %}

{% tab title="Example" %}

```
$report-nest hilton park, pikachu
```

{% endtab %}
{% endtabs %}

### report-migration

Sets all nests created by the current server to the nesting species that was reported BEFORE the last migration.. All nests listed in the nest channel will update live and search results will be updated for the next search. This command also edits the migration details message listed in the nest channel to the proper dates.

| Category  | Permissions | Channel |
| --------- | ----------- | ------- |
| Migration | Admin       | Admin   |
|           |             | Nest    |

{% tabs %}
{% tab title="Usage" %}

```
$revert-migration
```

{% endtab %}

{% tab title="Alias" %}

```
$revmigration
```

{% endtab %}
{% endtabs %}

### update-nest

Update data about a nest that was created by the current community.

| Category | Permissions | Channel |
| -------- | ----------- | ------- |
| Nests    | Admin Role  | Admin   |

{% hint style="success" %}
**Arguments:**\
**`pokestops` | `gyms` | `exgyms` | `spawns` |`city` | `region` |`state | country | google`**
{% endhint %}

{% tabs %}
{% tab title="Usage" %}

```
$update-nest <nest name>, [argument], [new data]
```

{% endtab %}

{% tab title="Alias" %}

```
$un <nest name>, [argument], [new data]
```

{% endtab %}

{% tab title="Example" %}

```
$update-nest hilton park, pokestops, 20
$update-nest hilton park, google, 33.759771, -84.392331
```

{% endtab %}
{% endtabs %}

See the below link for additional help and examples on updating nests

{% content-ref url="/pages/-Lo3fqJUTf40rBn\_via-" %}
[Updating Nests](/pokecloud/master/admin-guides/nest-management/updating-nests.md)
{% endcontent-ref %}

###