# dev convert messages

Convert a .json messages file into Markdown.

## Description for dev convert messages

Preserves the filename and the original messages file, then creates a new file with the Markdown extension and standard headers for the command and flag summaries, descriptions, and so on. After you review the new Markdown file, delete the old .json file.

## Flags

| Flag Name (Long) | Flag Name (Short) | Description                                                                                                  |
| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------ |
| `--file-name`    | `-f`              | **Type:** Value<br>**Required**<br><br>Filename to convert.                                                  |
| `--flags-dir`    | N/A               | **Type:** Value<br><br>Import flag values from a directory.                                                  |
| `--json`         | N/A               | **Type:** Boolean<br><br>Format output as json.                                                              |
| `--project-dir`  | `-p`              | **Type:** Value<br>**Default value:** `.`<br><br>Location of the project whose messages are to be converted. |

## Examples for dev convert messages

Convert the my-command.json message file into my-command.md with the standard messages headers:

```shell
sf dev convert messages --filename my-command.json
```

```shell
Similar to previous example, but specify the plugin project directory:
```

```shell
sf dev convert messages --project-dir ./path/to/plugin --filename my-command.json
```