amqtt/docs/references/amqtt.md

# amqtt

`amqtt` is a command-line script for running a MQTT 3.1.1 broker.

## Usage

`amqtt` usage:

```
amqtt --version
amqtt (-h | --help)
amqtt [-c <config_file> ] [-d]
```

## Options

- `--version` - amqtt version information
- `-h, --help` - Display `amqtt_sub` usage help
- `-c` - Set the YAML configuration file to read and pass to the client runtime.

## Configuration

Without the `-c` argument, the broker will run with the following, default configuration:

```yaml
--8<-- "../amqtt/amqtt/scripts/default_broker.yaml"
```

Using the `-c` argument allows for configuration with a YAML structured file; see [broker configuration](broker_config.md).
updating title 2025-05-28 13:35:03 +00:00			`# amqtt`
updating documentation, cleanup broken links. overhaul of the quickstart guide. 2025-05-20 23:40:56 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			`amqtt` is a command-line script for running a MQTT 3.1.1 broker.
updating documentation, cleanup broken links. overhaul of the quickstart guide. 2025-05-20 23:40:56 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			`## Usage`
updating documentation, cleanup broken links. overhaul of the quickstart guide. 2025-05-20 23:40:56 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			`amqtt` usage:
updating documentation, cleanup broken links. overhaul of the quickstart guide. 2025-05-20 23:40:56 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			```
			`amqtt --version`
			`amqtt (-h \| --help)`
			`amqtt [-c <config_file> ] [-d]`
			```
updating documentation, cleanup broken links. overhaul of the quickstart guide. 2025-05-20 23:40:56 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			`## Options`
updating documentation, cleanup broken links. overhaul of the quickstart guide. 2025-05-20 23:40:56 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			- `--version` - amqtt version information
			- `-h, --help` - Display `amqtt_sub` usage help
			- `-c` - Set the YAML configuration file to read and pass to the client runtime.
updating documentation, cleanup broken links. overhaul of the quickstart guide. 2025-05-20 23:40:56 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			`## Configuration`
updating documentation, cleanup broken links. overhaul of the quickstart guide. 2025-05-20 23:40:56 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			Without the `-c` argument, the broker will run with the following, default configuration:
updating documentation, cleanup broken links. overhaul of the quickstart guide. 2025-05-20 23:40:56 +00:00
convert rst files to md 2025-05-21 13:53:46 +00:00			```yaml
consolidating configuration documentation for both broker and client. including making sure there's consistency in default configuration 2025-05-28 11:45:12 +00:00			`--8<-- "../amqtt/amqtt/scripts/default_broker.yaml"`
convert rst files to md 2025-05-21 13:53:46 +00:00			```
updating documentation, cleanup broken links. overhaul of the quickstart guide. 2025-05-20 23:40:56 +00:00
consolidating configuration documentation for both broker and client. including making sure there's consistency in default configuration 2025-05-28 11:45:12 +00:00			Using the `-c` argument allows for configuration with a YAML structured file; see [broker configuration](broker_config.md).