https://github.com/henrybarreto/wk
Simplify your directory navigation with WK, the human go-to tool.
https://github.com/henrybarreto/wk
cli linux rust simple tool workspace
Last synced: about 2 months ago
JSON representation
Simplify your directory navigation with WK, the human go-to tool.
- Host: GitHub
- URL: https://github.com/henrybarreto/wk
- Owner: henrybarreto
- License: mit
- Created: 2022-06-04T00:52:47.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T22:28:51.000Z (almost 2 years ago)
- Last Synced: 2025-02-24T05:55:57.734Z (over 1 year ago)
- Topics: cli, linux, rust, simple, tool, workspace
- Language: Rust
- Homepage:
- Size: 44.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
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:
```sh
git clone https://github.com/henrybarreto/wk.git
```
Go to the repository folder:
```sh
cd wk
```
Then, install it:
```sh
make install
```
## How to use
**Save a workspace**
```sh
wk save home $(pwd)
```
**Go to a saved workspace**
```sh
wk go home
```
**Remove a saved workspace**
```sh
wk remove home
```
**Show saved workspaces**
```sh
wk list
```
**Show usage**
```sh
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.
```ron
(workspaces:[(name:"wk",path:"")])
```