warp-directory 0.3.1

A simple command line tool to quickly change directories
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

# warp-directory

![Crates.io Version](https://img.shields.io/crates/v/warp-directory?style=for-the-badge)
![Crates.io Total Downloads](https://img.shields.io/crates/d/warp-directory?style=for-the-badge)
![GitHub Release](https://img.shields.io/github/v/release/data5tream/warp-directory-rs?label=GitHub&style=for-the-badge)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/data5tream/warp-directory-rs/lint.yml?label=clippy&style=for-the-badge)
![GitHub License](https://img.shields.io/github/license/data5tream/warp-directory-rs?style=for-the-badge&color=blue)

> Easily switch between directories in your terminal with warp points. Supports zsh and bash.

## Installation

### Via cargo

Install the `warp-directory` binary using `cargo`:

```bash
cargo install warp-directory
```

### Build from source

Clone the repository and install the `warp-directory` binary using `cargo`:

```bash
cargo install --path .
```

## Configuration

Add the following to your zsh configuration file (e.g., `~/.zshrc` or `~/.bashrc`):

If running zsh:

```bash
eval "$(warp-directory init zsh)"
```

Or, if you run bash:

```bash
eval "$(warp-directory init bash)"
```

Source your config or open a new terminal.

## Usage

List warp points:

```bash
warp list
```

Add a warp point:

```bash
warp add <name> <path>
```

If `<path>` is not provided, the current directory will be used. You can add a description that will
be shown when using `warp list` by using the `--description` flag.

Remove a warp point:

```bash
warp delete <name>
```

Show the help message:

```bash
warp --help
```