# API reference

Reference for the API.

---

## Functions

Available public functions on the module:

---

### Function `run()`

```{eval-rst}
.. autofunction:: clig.run
```

---

### Function `data()`

```{eval-rst}
.. autofunction:: clig.data
```

---

### Function `command()`

```{eval-rst}
.. autofunction:: clig.command
```

---

### Function `subcommand()`

```{eval-rst}
.. autofunction:: clig.subcommand
```

---

### Function `wrapperformatter()`

```{eval-rst}
.. autofunction:: clig.wrapperformatter
```

---

## Arguments for functions

Descriptions for some arguments available for functions, forwaded to objects
factories.

---

### `RunArguments()`

```{eval-rst}
.. autoclass:: clig.RunArguments
    :members:
```

---

### `CommandArguments()`

```{eval-rst}
.. autoclass:: clig.CommandArguments
    :members:
```

---

### `CompleteCommandArguments()`

```{eval-rst}
.. autoclass:: clig.CompleteCommandArguments
    :members:
```

---

## Classes

Available public classes on the module:

---

### Class `Command()`

```{eval-rst}
.. autoclass:: clig.Command()
    :members:
    :undoc-members:
    :class-doc-from: class
```

---

### Class `ArgumentGroup()`

```{eval-rst}
.. autoclass:: clig.ArgumentGroup()
    :members:
    :undoc-members:
    :class-doc-from: class
```

---

### Class `MutuallyExclusiveGroup()`

```{eval-rst}
.. autoclass:: clig.MutuallyExclusiveGroup()
    :members:
    :undoc-members:
    :class-doc-from: class
```

---

### Class `ArgumentMetaData()`

```{eval-rst}
.. autoclass:: clig.ArgumentMetaData()
    :members:
    :undoc-members:
    :class-doc-from: class
```

---

### Class `Context()`

```{eval-rst}
.. autoclass:: clig.Context()
    :members:
    :undoc-members:
    :class-doc-from: class
```

---

### Class `DocStr()`

```{eval-rst}
.. autoclass:: clig.DocStr()
    :members:
    :undoc-members:
    :class-doc-from: class
```