Skip to content

Simplify your directory navigation with WK, the human go-to tool.

License

Notifications You must be signed in to change notification settings

henrybarreto/wk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WK's dark logo WK's light logo

Simplify your directory navigation with WK, the human go-to tool

WK is a command-line interface (CLI) tool that allows users to navigate to directories more easily by saving and managing "workspaces". A workspace consists of a name and a path and can be saved, removed, or listed by the user. The configuration of workspaces is stored in a file and can be loaded, modified, and saved by the WK application.

How to install

In order to install wk, you need the cargo installed.

First, clone the repository:

git clone https://github.com/henrybarreto/wk.git

Go to the repository folder:

cd wk

Then, install it:

make install

How to use

Save a workspace

wk save home $(pwd)

Go to a saved workspace

wk go home

Remove a saved workspace

wk remove home

Show saved workspaces

wk list

Show usage

wk help

How to configure

When you save a workspace, the file ~/.wk.ron is created/populated with that data, but you can also create/edit this file manually.

(workspaces:[(name:"wk",path:"<PATH TO WK>")])