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

# Commands

The command is `/itemblocker`, or `/ib`. Every command has tab completion, and `/ib help` lists the ones you may use.

## Options

Most commands take `key:value` options in any order.

| Option                                                       | Takes                                                                                                   | Example                     |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- | --------------------------- |
| `actions:`                                                   | a comma separated list of [actions](/itemblocker/rules/actions.md), `all`, `obtain` or `none`           | `actions:place,use`         |
| `worlds:`                                                    | a comma separated list of worlds, or `all`                                                              | `worlds:world,world_nether` |
| `in:`                                                        | a preset; `default` when left out                                                                       | `in:pvp`                    |
| `bypass:`                                                    | a permission that ignores just this rule, or `none`                                                     | `bypass:vip.elytra`         |
| `level:`                                                     | a level from 1; 1 when left out                                                                         | `level:5`                   |
| `mode:`                                                      | an [enchantment mode](/itemblocker/rules/enchantments.md): `block`, `downgrade`, `remove`, `confiscate` | `mode:downgrade`            |
| `stack:`, `inventory:`                                       | an amount, or `none`                                                                                    | `stack:4`                   |
| `type:`, `name:`, `lore:`, `model:`, `data:`, `enchantment:` | [filter criteria](/itemblocker/rules/filters.md)                                                        | `name:"Sword of Kings"`     |

Values with spaces go in double quotes. `hand` stands for the item in your main hand wherever an item is expected.

## Items

| Command                                                       | Does                                        | Permission           |
| ------------------------------------------------------------- | ------------------------------------------- | -------------------- |
| `/ib block <item\|hand> [actions:] [worlds:] [bypass:] [in:]` | Blocks actions, adding to an existing rule  | `itemblocker.add`    |
| `/ib edit <item\|hand> [actions:] [worlds:] [bypass:] [in:]`  | Replaces the parts of a rule you give       | `itemblocker.edit`   |
| `/ib unblock <item\|hand> [in:]`                              | Removes a rule                              | `itemblocker.remove` |
| `/ib limit <item\|hand> [stack:] [inventory:] [in:]`          | Sets [limits](/itemblocker/rules/limits.md) | `itemblocker.limit`  |

## Groups, allowed items and filters

| Command                                                                      | Does                                                                 | Permission           |
| ---------------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------- |
| `/ib group add <pattern> [actions:] [worlds:] [bypass:] [in:]`               | Adds or replaces a [group](/itemblocker/rules/groups-and-allowed.md) | `itemblocker.group`  |
| `/ib group remove <pattern> [in:]`                                           | Removes a group                                                      | `itemblocker.group`  |
| `/ib group list [in:]`                                                       | Lists groups                                                         | `itemblocker.group`  |
| `/ib allow add <item\|hand> [in:]`                                           | Allows an item type                                                  | `itemblocker.allow`  |
| `/ib allow remove <item\|hand> [in:]`                                        | Removes it from the allowed items                                    | `itemblocker.allow`  |
| `/ib allow list [in:]`                                                       | Lists allowed items                                                  | `itemblocker.allow`  |
| `/ib filter add <id> [hand] [criteria] [actions:] [worlds:] [bypass:] [in:]` | Adds or replaces a [filter](/itemblocker/rules/filters.md)           | `itemblocker.filter` |
| `/ib filter remove <id> [in:]`                                               | Removes a filter                                                     | `itemblocker.filter` |
| `/ib filter list [in:]`                                                      | Lists filters                                                        | `itemblocker.filter` |

## Enchantments and potion effects

| Command                                               | Does                                                           | Permission                |
| ----------------------------------------------------- | -------------------------------------------------------------- | ------------------------- |
| `/ib block enchantment <name> [level:] [mode:] [in:]` | Blocks an [enchantment](/itemblocker/rules/enchantments.md)    | `itemblocker.enchantment` |
| `/ib unblock enchantment <name> [in:]`                | Removes it                                                     | `itemblocker.enchantment` |
| `/ib block potion <effect> [level:] [in:]`            | Blocks a [potion effect](/itemblocker/rules/potion-effects.md) | `itemblocker.potion`      |
| `/ib unblock potion <effect> [in:]`                   | Removes it                                                     | `itemblocker.potion`      |

## Looking things up

| Command                                                    | Does                                                                       | Permission         |
| ---------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------ |
| `/ib show <item\|hand>`                                    | Rules, limits and, for `hand`, matching filters of an item in every preset | `itemblocker.info` |
| `/ib show enchantment <name>` / `/ib show potion <effect>` | The levels blocked in every preset                                         | `itemblocker.info` |
| `/ib list`                                                 | Every preset with its numbers of rules                                     | `itemblocker.list` |
| `/ib list items\|limits\|enchantments\|potions [in:]`      | The rules of one kind                                                      | `itemblocker.list` |

## Presets and templates

| Command                                            | Does                                                  | Permission           |
| -------------------------------------------------- | ----------------------------------------------------- | -------------------- |
| `/ib preset list`                                  | Lists presets                                         | `itemblocker.list`   |
| `/ib preset show <name>`                           | Shows a preset                                        | `itemblocker.info`   |
| `/ib preset create <name>`                         | Creates an empty preset                               | `itemblocker.preset` |
| `/ib preset delete <name>`                         | Deletes a preset and its rules                        | `itemblocker.preset` |
| `/ib preset edit <name> description <text>`        | Sets the description; no text clears it               | `itemblocker.preset` |
| `/ib preset edit <name> reason <text>`             | Sets the reason shown to players; no text clears it   | `itemblocker.preset` |
| `/ib preset edit <name> worlds <world ...\|all>`   | Limits the preset to worlds                           | `itemblocker.preset` |
| `/ib preset edit <name> regions <region ...\|all>` | Limits the preset to WorldGuard regions               | `itemblocker.preset` |
| `/ib template`                                     | Lists [templates](/itemblocker/features/templates.md) | `itemblocker.preset` |
| `/ib template <name> [as:<preset>]`                | Creates a preset from a template                      | `itemblocker.preset` |

## Other

| Command                                                                           | Does                                                                | Permission           |
| --------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -------------------- |
| `/ib gui`                                                                         | Opens the [menu](/itemblocker/features/menu.md)                     | `itemblocker.gui`    |
| `/ib scan players\|containers [remove\|confiscate] [actions:] [radius:] [world:]` | [Scans](/itemblocker/features/scanning.md) for forbidden items      | `itemblocker.scan`   |
| `/ib confiscated [take <owner>]`                                                  | Lists or takes confiscated items                                    | `itemblocker.scan`   |
| `/ib log [player]`                                                                | The last blocked actions, see [Logs](/itemblocker/features/logs.md) | `itemblocker.log`    |
| `/ib reload`                                                                      | Reloads `config.yml`, `rules.yml` and the messages                  | `itemblocker.reload` |
| `/ib help`                                                                        | Lists the commands you may use                                      | `itemblocker.use`    |

Every command also needs `itemblocker.use`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://opuszek.gitbook.io/itemblocker/reference/commands.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.