dirvish
dirvish copied to clipboard
alexluigit
A polished Dired with batteries included.
#+AUTHOR: Alex Lu
#+EMAIL: [email protected]
#+startup: content
#+html: 
#+html:
A polished Dired with batteries included
- Introduction
#+begin_quote The experience of dirvish is surreal and even bizarre after all these years of trying to use dired. Like how professionals make their craft look easy, dirvish does something similar with how it builds on dired. Dirvish is paradoxical in that it provides a completely different experience while still fundamentally being dired at its core.
-- @noctuid ([[https://github.com/alexluigit/dirvish/issues/34][source]]) #+end_quote
Dirvish is an improved version of the Emacs inbuilt package [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Dired.html][Dired]]. It not only gives Dired an appealing and highly customizable user interface, but also comes together with almost all possible parts required for full usability as a modern file manager.
[[https://user-images.githubusercontent.com/16313743/179333496-9b911fee-1305-45a0-99b0-7e81297d98a0.png][https://user-images.githubusercontent.com/16313743/179333496-9b911fee-1305-45a0-99b0-7e81297d98a0.png]]
- Prerequisites
This package requires =GNU ls= (~gls~ on some OSs), and /optionally/:
- =fd= as a faster alternative to =find=
- =imagemagick= for image preview
- =poppler= | =pdf-tools= for pdf preview
- =ffmpegthumbnailer= for video preview
- =mediainfo= for audio/video metadata generation
- =tar= and =unzip= for archive files preview
@@html:@@ Toggle install instructions @@html:
@@
@@html:
@@macOS@@html:
@@ #+begin_src bash brew install coreutils fd poppler ffmpegthumbnailer mediainfo imagemagick #+end_src@@html:
@@Debian-based@@html:
@@ #+begin_src bash apt install fd-find poppler-utils ffmpegthumbnailer mediainfo imagemagick tar unzip #+end_src@@html:
@@Arch-based@@html:
@@ #+begin_src bash pacman -S fd poppler ffmpegthumbnailer mediainfo imagemagick tar unzip #+end_src@@html:
@@FreeBSD@@html:
@@ #+begin_src bash pkg install gnuls fd-find poppler ffmpegthumbnailer ImageMagick7 gtar #+end_src@@html:
@@Windows (untested)@@html:
@@ #+begin_src bashinstall via Scoop: https://scoop.sh/
scoop install coreutils fd poppler imagemagick unzip #+end_src
@@html:@@
- Installation
Dirvish is available on [[https://melpa.org/#/dirvish][Melpa]]. Just type =M-x package-install RET dirvish RET= into Emacs 27.1+. =el-get= users can get the recipe from [[https://github.com/alexluigit/dirvish/issues/90][here]].
For straight.el users, it is simply: #+begin_src emacs-lisp (straight-use-package 'dirvish) #+end_src
- Quickstart
After installation, let Dirvish take over Dired globally: #+begin_src emacs-lisp (dirvish-override-dired-mode) #+end_src
-
=M-x dirvish RET=
Welcome to Dirvish! Press =?= for help.
-
=M-x dired= | =dired-jump= | ... =RET=
Dirvish takes care all of your Dired entries.
- Resources
- [[file:docs/CUSTOMIZING.org][Customizing]]
- [[file:docs/EXTENSIONS.org][Extensions]]
- [[file:docs/COMPARISON.org][Related projects]]
- [[file:docs/CHANGELOG.org][Changelog]]
- [[https://github.com/alexluigit/dirvish/discussions][Discussions]]
- Acknowledgements
Thanks Fox Kiester (@noctuid) for the awesome [[https://github.com/alexluigit/dirvish/issues/34][summary]] of Dirvish.
The name dirvish is a tribute to [[https://github.com/justinmk/vim-dirvish][vim-dirvish]].
[[https://melpa.org/#/dirvish][file:https://melpa.org/packages/dirvish-badge.svg]] [[https://stable.melpa.org/#/dirvish][file:https://stable.melpa.org/packages/dirvish-badge.svg]] [[https://github.com/alexluigit/dirvish/actions/workflows/melpazoid.yml][file:https://github.com/alexluigit/dirvish/actions/workflows/melpazoid.yml/badge.svg]]
alexluigit