---
title: "Overview"
description: "Show a diglot store in x18n's CLI, editor and browser UI."
canonical_url: "https://diglot.sh/review-ui/overview"
---
# Overview

> Show a diglot store in x18n's CLI, editor and browser UI.

<note>

`@diglot/x18n` is experimental and is built against x18n 0.1.10.

</note>

`@diglot/x18n` is a plugin for [x18n](https://github.com/x18n-dev/x18n), a tool for managing translations with a CLI, an editor and a browser UI. The plugin shows a diglot translations repository in those tools: each segment hash is a key, the source manifests hold the source-locale messages, each record file holds one translation, and every place where a segment occurs in a source document is a usage of its hash.

Use it when you want reviewers to work in x18n's UI instead of editing JSON files.

<package-info directory="packages/x18n" install="pnpm add -D @diglot/x18n @x18n/cli" name="@diglot/x18n">



</package-info>

```ts [x18n.config.ts]
import diglot from '@diglot/x18n'

export default {
  plugins: [diglot()],
}
```

Put `x18n.config.ts` next to `diglot.config.ts`. The plugin takes two options: `root`, the translations repository relative to the x18n project root (default: the project root), and `sourceLocale`, the locale of the source documents (default `en`).

## Usages

Usages come from the files under `.diglot/sources/<source>`, which [`diglot checkout`](https://diglot.sh/workflow/cli/checkout) exports as plain files at each source's configured ref. The plugin sets `usage.include` to those documents and `usage.gitignore` to `false`, so the git-ignored exports in the [Nuxt example](https://diglot.sh/guide/examples/nuxt-translations) are scanned. Run `checkout` before you use x18n.

## Next steps

- [What it adds](https://diglot.sh/review-ui/what-it-adds) lists the formats, checks and prompts the plugin registers.
- [Reviews](https://diglot.sh/review-ui/reviews) explains how an approval in x18n verifies a record.


## Sitemap

See the full [sitemap](https://diglot.sh/sitemap.md) for all pages.