# allyhub words

> A recording's words: heard on this computer when it has none (or --fresh), printed by word index with the sounds between them; a stretch by seconds, heard again with --fresh

Source: https://allyhub.com/docs/reference/cli/words · AllyHub 0.10.0
Index of all docs: https://allyhub.com/llms.txt

## Usage

```bash
allyhub words [file] [options]
```

## Arguments

| Argument | Type | What it is |
| --- | --- | --- |
| `<file>` | string | The recording: an audio or video file |

## Options

| Option | Type | Default | What it does |
| --- | --- | --- | --- |
| `--lang` | string |  | The language spoken (en, es, fr, de, zh…); left out, the cloud finds it |
| `--fresh` | boolean | `false` | Hear the whole file again and write its words file; with --from and --to, only that stretch, writing nothing |
| `--from` | number |  | Show the words of the file from this second on |
| `--to` | number |  | Show the words of the file up to this second |
| `--search` | list of string |  | Where these words or phrases are said (case and punctuation ignored; a phrase's last word may be a prefix), instead of the transcript |
| `--script` | string |  | A script to compare with: a video's script in one language (what its parts say) or a text file; marks words it does not have, {like this}, and lines said more than once |
| `--all` | boolean | `false` | Also list what the thresholds leave out: every stretch between words above the noise floor, every word's inside, and every script line |

## Global options

`--dir <value>`: the project's folder; default the one around where it is run. `--json`: print the result as JSON.

## Output

With `--json`, the command prints an object with these fields:

| Field | Type | What it is |
| --- | --- | --- |
| `file` | string |  |
| `wordsFile` |  |  |

## Examples

```bash
allyhub words talk/host.mp4
allyhub words host.mp4 --from 23 --to 25
allyhub words host.mp4 --from 23 --to 25 --fresh
allyhub words host.mp4 --search "you know,um"
```

## Exit codes

`0` when it succeeds; the others are listed in [Exit codes](https://allyhub.com/docs/reference/cli/exit-codes.md).

## In the work

**footage**: Cutting recorded footage: a talking head, an interview

`words` → [`words edits`](https://allyhub.com/docs/reference/cli/words-edits.md) → [`align`](https://allyhub.com/docs/reference/cli/align.md) → [`frames cuts`](https://allyhub.com/docs/reference/cli/frames-cuts.md) → [`audio recording`](https://allyhub.com/docs/reference/cli/audio-recording.md) → [`render`](https://allyhub.com/docs/reference/cli/render.md)

**references**: Studying reference videos, and a piece against them

[`reference`](https://allyhub.com/docs/reference/cli/reference.md) → [`reference compare`](https://allyhub.com/docs/reference/cli/reference-compare.md) → [`reference set`](https://allyhub.com/docs/reference/cli/reference-set.md) → [`frames`](https://allyhub.com/docs/reference/cli/frames.md) → [`frames compare`](https://allyhub.com/docs/reference/cli/frames-compare.md) → `words` → [`audio`](https://allyhub.com/docs/reference/cli/audio.md) → [`align`](https://allyhub.com/docs/reference/cli/align.md)
