KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

peep-dired

★ 101 Open GitHub ↗

A convienent way to look up file contents in other window while browsing directory in dired

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Moving this project to read-only

As described in the [ticket](https://github.com/asok/peep-dired/issues/17) I stopped using this package years ago. I have no time nor motivation to maintain it.
As it turns out [Protesilaos](https://protesilaos.com) created his own [package](https://github.com/protesilaos/dired-preview) that provides the same feature as peep-dired.

The quality of the work Protesilaos is putting into Emacs makes me confident that his package will be far better than mine. So if I were you I would make the switch :)

# Peep Dired

This is a minor mode that can be enabled from a dired buffer.
Once enabled it will show the file from point in the other window.
Moving to the other file within the dired buffer with <kbd>down</kbd>/<kbd>up</kbd> or
<kbd>C-n</kbd>/<kbd>C-p</kbd> will display different file.
Hitting <kbd>SPC</kbd> will scroll the peeped file down, whereas
<kbd>C-SPC</kbd> and <kbd>backspace</kbd> will scroll it up.

![Screenshot](https://github.com/asok/peep-dired/raw/master/screenshots/peep-dired-cast.gif)

## Installation

Once you have setup [Melpa](http://melpa.milkbox.net/#/getting-started) you can use `package-install` command to install Peep Dired. The package name is `peep-dired`.

## Configuration

### Customizing

When disabling the mode you can choose to kill the buffers that were opened while browsing the directories.
```el
(setq peep-dired-cleanup-on-disable t)
```

Or you can choose to kill the buffer just after you move to another entry in the dired buffer.
```el
(setq peep-dired-cleanup-eagerly t)
```

If you want the dired buffers that were peeped to have the mode enabled set it to true.
```el
(setq peep-dired-enable-on-directories t)
```

### Evil integration
Adjust the state name depending on an evil state you open dired in:

```
(evil-define-key 'normal peep-dired-mode-map (kbd "<SPC>") 'peep-dired-scroll-page-down
                                             (kbd "C-<SPC>") 'peep-dired-scroll-page-up
                                             (kbd "<backspace>") 'peep-dired-scroll-page-up
                                             (kbd "j") 'peep-dired-next-file
                                             (kbd "k") 'peep-dired-prev-file)
(add-hook 'peep-dired-hook 'evil-normalize-keymaps)
```

## Ignoring Certain File Extensions

You probably don't want to open certain files like videos when using Peep Dired. To ignore certain files when moving over them you can customize the following to your liking:

```
(setq peep-dired-ignored-extensions '("mkv" "iso" "mp4"))
```

## Alternatives

* [dired-preview](https://github.com/protesilaos/dired-preview) can be treated as a better replacement for Peep-Dired
* [ranger.el](https://github.com/ralesi/ranger.el) emulates [ranger](http://ranger.nongnu.org/) in dired. It has the preview feature similar to Peep-Dired.
* [diredc](https://github.com/Boruch-Baum/emacs-diredc) extensions to dired. It has a browse mode which has a similar feature to Peep-Dired.

## Contribution

Install [cask](https://github.com/rejeep/cask.el) if you haven't already, then:

```bash
$ cd /path/to/peep-dired
$ cask
```

Run all tests with:

```bash
$ make test
```

peep-dired

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README