dotfiles/yazi_1/.config/yazi/plugins/file-extra-metadata.yazi/README.md

# file-extra-metadata

<!--toc:start-->

- [file-extra-metadata](#file-extra-metadata)
  - [Preview](#preview)
    - [Before:](#before)
    - [After:](#after)
  - [Requirements](#requirements)
  - [Installation](#installation)
  - [For developer](#for-developer)
  <!--toc:end-->

This is a Yazi plugin that replaces the default file previewer and spotter with extra information.

> [!IMPORTANT]
> Minimum version: yazi v25.5.28

## Preview

### Before:

- Previewer

  ![Before preview](statics/2024-11-17-12-06-24.png)

- Spotter

  ![Before spot](statics/2025-12-29-before_spotter.png)

### After:

- Previewer

  ![After previewer](statics/2024-11-21-05-27-48.png)

- Spotter

  ![After spotter](statics/2025-12-29-after_spotter.png)

## Requirements

- [yazi >= 25.5.28](https://github.com/sxyazi/yazi)
- Tested on Linux. For MacOS, Windows: some fields will shows empty values.

## Installation

Install the plugin:

```sh
ya pkg add boydaihungst/file-extra-metadata
```

Create `~/.config/yazi/yazi.toml` and add:  
For yazi < v25.12.29 (29/12/2025) replace `url` with `name`

```toml
[plugin]
  append_previewers = [
    { url = "*", run = "file-extra-metadata" },
  ]

  # Setup keybind for spotter: https://github.com/sxyazi/yazi/pull/1802
  append_spotters = [
    { url = "*", run = "file-extra-metadata" },
  ]
```

or

```toml
[plugin]
  previewers = [
    # ... the rest
    # disable default file plugin { name = "*", run = "file" },
    { url = "*", run = "file-extra-metadata" },
  ]

  # Setup keybind for spotter: https://github.com/sxyazi/yazi/pull/1802
  spotters = [
    # ... the rest
    # Fallback
    # { name = "*", run = "file" },
    { url = "*", run = "file-extra-metadata" },
  ]
```

### Custom theme

Read more: https://github.com/sxyazi/yazi/pull/2391

Edit or add `yazi/theme.toml`:

```toml
[spot]
border = { fg = "#4fa6ed" }
title = { fg = "#4fa6ed" }

# Table.
tbl_cell = { fg = "#4fa6ed", reversed = true }
tbl_col = { fg = "#4fa6ed" }
```

## For developer

If you want to combine this with other spotter/previewer:

```lua
require("file-extra-metadata"):render_table(job, { show_plugins_section = true })
```