https://github.com/kevinywlui/nik

cd using subsequence matching and frecency.
https://github.com/kevinywlui/nik

Last synced: 29 days ago
JSON representation

cd using subsequence matching and frecency.

• Host: GitHub
• URL: https://github.com/kevinywlui/nik
• Owner: kevinywlui
• License: mit
• Created: 2020-01-24T22:11:14.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-23T20:59:30.000Z (almost 5 years ago)
• Last Synced: 2023-05-06T16:41:04.410Z (over 1 year ago)
• Language: Go
• Homepage:
• Size: 43 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nik

`nik` - cd using subsequence matching and frecency.

Powered by golang and sqlite.

This program is essentially the same as

[autojump](https://github.com/wting/autojump),

[z](https://github.com/rupa/z),

and

[fasd](https://github.com/clvv/fasd). It was created to help me learn golang.

## Warning

The testing and error handling is severely lacking.

## Installation

Installation is done in 2 steps, installing the golang binary and then shell helper. 

### golang binary 

First install `golang` following the instructions here: . Next install `nik`:

```

go get github.com/kevinywlui/nik

```

### Shell helper

Now we need to source the `nik.zsh` file. Add the following somewhere in your `~/.zshrc`

```

source `go env GOPATH`/src/github.com/kevinywlui/nik/nik.zsh

```

## Usage

The basic usage is executing

```

j bar

```

which will try to `cd` into a path, `/pre/.../fix/dir`, so that `dir` is a

subsequence of `bar`. Alternatively, executing

```

j foo bar

```

will try to `cd` into a path, `/pre/.../fix/dir`, so that `bar` is a subsequence

of `dir` and `foo` is a subsequence of `/pre/.../fix/`.

Alternatively, run `nik help` to see the possibilities with the `nik` command.