https://github.com/nanvenomous/where-to

Jump from one place to another on your OS with the help of command completion and a simple config file.
https://github.com/nanvenomous/where-to

bash command-line go golang navigation productivity shell system-programming zsh

Last synced: about 1 month ago
JSON representation

Jump from one place to another on your OS with the help of command completion and a simple config file.

• Host: GitHub
• URL: https://github.com/nanvenomous/where-to
• Owner: nanvenomous
• License: gpl-3.0
• Created: 2022-07-13T05:52:07.000Z (over 2 years ago)
• Default Branch: mainline
• Last Pushed: 2022-12-29T22:03:11.000Z (almost 2 years ago)
• Last Synced: 2023-03-10T10:44:52.188Z (almost 2 years ago)
• Topics: bash, command-line, go, golang, navigation, productivity, shell, system-programming, zsh
• Language: Go
• Homepage:
• Size: 9.74 MB
• Stars: 18
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![gopher portal](./.rsrc/gopher.png)

# where-to

I'm here, I'm there ;)

### `to` command jumps from one place to another on your OS with the help of command completion and a simple config file.

![demo](./.rsrc/where-to.gif)

### `dn` & `up` commands navigate up or down a directory with a post hook to clear and list the contents.

![up and down](./.rsrc/up_and_down.gif)

### `t` command justs clears and lists the current directory vertically.

![new ls](./.rsrc/new_ls_t.gif)

# Dependencies

By default, where-to uses the `ls` to show directories.

You can install [exa](https://github.com/ogham/exa) or [tree](https://gist.github.com/fscm/9eee2784f101f21515d66321180aef0f) for a better experience.

# Installation

### 1. binaries

You can grab a precompiled binary from the [releases page](https://github.com/nanvenomous/where-to/releases/)

Then run the following for the liunx binary for example:

```

tar -xf linux.tar.xz

cd ./bin/linux

sudo mv ./* /usr/local/bin/

```

If you prefer to install from source (this requires you to [install go](https://go.dev/doc/install))

```

git clone https://github.com/nanvenomous/where-to.git

cd where-to

make

sudo make install

```

### 2. completions

You will need to run the completion command for your given shell

Note: check which shell you are running with `echo "${SHELL}"`

Then run **only one** of the following

```

sudo make zsh-completions

sudo make bash-completions

```

### 3. You need to add the plugin to your shell

Add the following line to your shell file (i.e. `.bashrc` or `.zshrc`):

```

eval "$(where-to init)"

```

### 4. Configuration (i.e. adding places to go)

You can always edit `~/.config/where-to.yaml` manually

but I recommend to use the convenience functions

here's an example where I add an alias for `~/.config/nvim` so I can edit my neovim config file:

![convenience functions](./.rsrc/convenience-functions.gif)

The config file maps an alias to a directory on your machine so you can run:

> to [alias]

and you will be navigated to the corresponding directory

### Shell compatibility

Pull requests welcome!

- [x] zsh

- [x] bash

- [ ] fish

- [ ] xonsh

# Motivation

This project is heavily inspired by [zoxide](https://github.com/ajeetdsouza/zoxide)

However, `where-to` has a more declarative approach & focuses on autocompletion rather than fuzzy-finding

for example, if you don't know where you want to go try running

> to \t

(that's to\\)

![autocomplete example](./.rsrc/where-to-autocomplete-example.png)

and find your way from there!