# Add words to your dictionary

import { Aside, Tabs, TabItem, Steps } from '@astrojs/starlight/components';

EkLine's spell-check rule flags words it doesn't recognize. That's useful for catching typos, but it also flags product names, acronyms, and domain jargon that are spelled correctly for your team. Add those words to your dictionary once, and EkLine treats them as valid everywhere you review.

Your dictionary lives in your EkLine account, so it applies to every review surface connected to your token — the CLI, CI pipelines, the VS Code extension, and the PR bot.

## Before you start

You need:

- An EkLine account with access to the [EkLine Dashboard](https://ekline.io/dashboard).
- One review surface set up to test the result: the [CLI](/reviewer/quickstart/cli), a [CI integration](/reviewer/quickstart), or the [VS Code extension](/reviewer/integrations/vscode-integration).

<Aside type="note" title="Dictionary or ignore rule?">
The dictionary teaches EkLine a correctly spelled word so the spell-check rule `EK00300` accepts it. To turn a rule off entirely instead, see [Ignoring rules](/reviewer/configuration/ignoring-rules).
</Aside>

---

## Step 1: Open your dictionary

<Steps>

1. Go to the [EkLine Dashboard](https://ekline.io/dashboard).

2. Open **Dictionary** at [ekline.io/dictionary](https://ekline.io/dictionary).

</Steps>

The dictionary shows your saved words, each with a **Case sensitive** toggle, and an empty row ready for a new entry.

---

## Step 2: Add your words

<Steps>

1. Enter a word in the **Word** field. You can add a multi-word term, such as a product name with spaces.

2. Set the **Case sensitive** toggle for that word (see [Match exact capitalization](#match-exact-capitalization) below).

3. Click **Add another word** and repeat for each term you want EkLine to accept.

4. Click **Update** to save your dictionary.

</Steps>

A confirmation message appears when your dictionary saves. EkLine applies the new words on your next review.

<Aside type="tip">
Add the words your team uses most: product and feature names, command names, library names, and acronyms. These are the words a general spell checker flags most often.
</Aside>

### Match exact capitalization

The **Case sensitive** toggle controls how EkLine matches a word:

| Toggle | Behavior | Example |
|--------|----------|---------|
| Off (default) | EkLine accepts the word in any capitalization. | `kubernetes`, `Kubernetes`, and `KUBERNETES` all pass. |
| On | EkLine accepts only the exact spelling you enter. Other capitalizations are still checked. | Adding `EkLine` accepts `EkLine`, but `ekline` is still reviewed. |

Turn the toggle on when the correct form of a word depends on its capitalization, so EkLine keeps flagging the wrong casing.

---

## Verify that EkLine accepts your words

Run a review against content that has one of the words you added, and confirm EkLine no longer flags it.

<Tabs>
  <TabItem label="CLI">
    ```bash
    ekline-cli --ek-token YOUR_TOKEN --content-directory ./docs
    ```

    The word no longer appears in the output with a spelling suggestion:

    ```
    [EK00300] "responce" should be "response"
    ```
  </TabItem>
  <TabItem label="VS Code">
    Open a file that uses the word and run **EkLine: Review current document** from the Command Palette (`Cmd/Ctrl` + `Shift` + `P`). The word no longer appears in the **EkLine Suggestions** panel.
  </TabItem>
</Tabs>

If the word still gets flagged, see the troubleshooting steps below.

---

## Troubleshooting

### EkLine still flags a word I added

- Confirm you clicked **Update** after adding the word. The dictionary saves only when you do.
- Check the **Case sensitive** toggle. If it's on, EkLine accepts only the exact capitalization you entered. Turn it off to accept every capitalization.
- Run the review again. EkLine applies dictionary changes on the next review, not to results from a review that already ran.

### The same word appears twice

EkLine prevents duplicate entries. If you see a duplicate error, remove the extra row with the **X** button next to it, then save.

### Enforce a preferred term instead of accepting a word

The dictionary accepts a word but doesn't suggest a replacement. To steer writers from one term to another — for example, from `e-mail` to `email` — use terminology rules. Contact [support@ekline.io](mailto:support@ekline.io) to set up custom terminology.

---

## Next steps

- [Ignoring rules](/reviewer/configuration/ignoring-rules) — turn off a rule or skip specific content.
- [Choose and apply a style guide](/reviewer/configuration/style-guides) — set the writing standard EkLine enforces.
- [CLI reference](/reviewer/integrations/cli-integration/) — all configuration options and flags.