<commit_before># Options Reference

Options have a 2-hyphen prefix, e.g. `--format`. The value follows, either separated by a space or an equal sign -- `--format mp3` and `--format=mp3` are equally valid.

## `--access-key` / `--secret-key`

**Supported: AWS**

The access key and secret key are the credentials that AWS uses to identify your account. If you do not want to put your credentials in a [configuration file](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-shared.html), or if you want to use credentials different than what are in your configuration file, you will need to specify them when you run tts-cli.

```
$ tts test.txt test.mp3 --access-key ABCDEFG --secret-key <KEY>
```

## `--effect`

**Supported: GCP**

Adds an audio effect to the speech after synthesis. Can be specified multiple times -- effects are applied on top of each other in the order given.

```
$ tts test.txt test.mp3 --service gcp --effect effect1 --effect effect2
```

## `--email`

**Supported: GCP**

Specifies the email address used to identify the account. This is the same as the `client_email` for your GCP project.

```
$ tts test.txt test.mp3 --service gcp --email starting-account-kjd6bvn58@alert-vista-12345.iam.gserviceaccount.com --private-key-file .\key.pem
```

## `--ffmpeg`

**Supported: AWS, GCP**

Specifies the location of the `ffmpeg` program on your machine. Ideally, the program would automatically be located (usually through the `PATH` environment variable), but you can specify it manually.

```
$ tts test.txt test.mp3 --ffmpeg C:\ffmpeg\ffmpeg.exe
```

## `--format`
<commit_msg>docs(options): Add to --effect docs<commit_after># Options Reference

Options have a 2-hyphen prefix, e.g. `--format`. The value follows, either separated by a space or an equal sign -- `--format mp3` and `--format=mp3` are equally valid.

## `--access-key` / `--secret-key`

**Supported: AWS**

The access key and secret key are the credentials that AWS uses to identify your account. If you do not want to put your credentials in a [configuration file](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-shared.html), or if you want to use credentials different than what are in your configuration file, you will need to specify them when you run tts-cli.

```
$ tts test.txt test.mp3 --access-key ABCDEFG --secret-key <KEY>
```

## `--effect`

**Supported: GCP**

Adds an audio effect (also called an audio profile or a device profile) to the speech after synthesis. Can be specified multiple times -- effects are applied on top of each other in the order given.

```
$ tts test.txt test.mp3 --service gcp --effect handset-class-device
```

See the [GCP documentation](https://cloud.google.com/text-to-speech/docs/audio-profiles) for the available effects.

## `--email`

**Supported: GCP**

Specifies the email address used to identify the account. This is the same as the `client_email` for your GCP project.

```
$ tts test.txt test.mp3 --service gcp --email <EMAIL> --private-key-file .\key.pem
```

## `--ffmpeg`

**Supported: AWS, GCP**

Specifies the location of the `ffmpeg` program on your machine. Ideally, the program would automatically be located (usually through the `PATH` environment variable), but you can specify it manually.

```
$ tts test.txt test.mp3 --ffmpeg C:\ffmpeg\ffmpeg.exe
```

## `--format`

{'fraction_non_alphanumeric': 0.12422907488986784, 'fraction_numerical': 0.0076358296622613805, 'mean_word_length': 3.8312056737588653, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 1, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 12, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4690070', 'n_tokens_mistral': 1060, 'n_tokens_neox': 1017, 'n_words': 425}