Skip to content

sahwar/sodalite

 
 

Repository files navigation

Sodalite: Exploration at the speed of thought

Yet another file explorer

Have you ever played crawl? That's a terminal based roguelike dungeon crawler.
What makes it stand out is it's extremely efficient menu navigation philsophy.

dcss inventar management

Dungeon Crawl Stone Soup: For selecting an item, press it's automatically assigned key.

After a while, the keys burn into one's muscle memory - using the game's interface feels extremely efficient.
sodalite brings the same feature to your file system: Navigation at the speed of thought.

Navigate the file system

When opening sodalite, you will see the listing of the current directory.
Pressing one of the keys displayed in front of the entries will navigate there.

Sodalite

Assign the most intuitive and/or reachable keys to your most frequently used entries, and stick with this assignment. Once setup, and muscle memory kicks in, all directories will be reachable in a blink of an eye!

Installation

Linux

Debian and derivates

You can use this two-liner and you're ready to go:

curl -sL repo.hnicke.de/apt/debian/add-repo | sudo bash
sudo apt-get install sodalite

The add-repo script adds the repository repo.hnicke.de/apt/debian/repos to your apt repositories and installs the necessary public keys.

Note: Sodalite depends on python3 (>=3.6). If you're running debian (stable), you probably have to manually install it first.

We're working on getting the package into the official debian repo.

Arch Linux

AUR package sodalite (stable release):

yaourt -S sodalite

AUR package sodalite-git (master branch):

yaourt -S sodalite-git

OSX

  1. Install brew:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

  1. Install dependencies:
    1. python3: brew install python3
    2. other: pip3 install -r requirements.txt
  2. run sudo make install

Manual Installation

In order to manually install sodalite, clone this repository, cd to the project root and execute:

sudo make prefix=/usr sysconfdir=/etc install

Replace the values for prefix and sysconfdir with the appropriate directories for your OS.

The project adheres to the GNU Makefile Conventions. In case it doesn't it's considered a bug - please file a bug report.

Necessary dependencies:

Getting started

Check out the manpage for detailed usage information.

FAQ

The default 'open' hook doesn't work / launches weird programs :(

Most probably it is not sodalite's fault, but your mime default application list isn't configured correctly. You could try this:

xdg-mime default <desktop> $(xdg-mime query filetype <file>)

Replace <file> with the file you're trying to open and <desktop> with name of the desktop entry file of your new default app. If you're not sure what's the name of the desktop entry of a specific app, look for it in /usr/share/applications.

Alternatively you can edit the mime app list manually: $HOME/.config/mimeapps.list

Or learn more about mime.

Changelog

Don't miss out on what has changed: Read the changelog.

Contributing

Do you want to contribute to the project? Check out the developer guide.

License

See copyyright.

About

A keyboard-driven, terminal-based file navigator and launcher: Exploration at the speed of thought.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 92.1%
  • Shell 5.7%
  • Makefile 2.2%