pathman 0.1.2

A cross-platform library for managing the PATH environment variable.
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

# Pathman

**Pathman** is a _cross-platform_ Rust library for prepending and appending
directories to the user's `PATH` environment variable.

- 🚀 **Cross-platform**. Works on Windows, macOS, and Linux
- 1️⃣ **Idempotent**. Does not duplicate entries in the `PATH`
- 💬 **Comments**. Supports adding custom comments in shell config files

## Installation

Run the following command to add **Pathman** to your project's dependencies.

```bash
cargo add pathman
```

## Usage

### Prepending a directory to the `PATH`

Use the `prepend_to_path` function to add a directory to the beginning of the 
`PATH` environment variable, which will ensure that the specified directory
will be searched first when executing commands. An optional comment can be
specified, and it will be added to the shell configuration file on macOS and
Linux.

```rust
use pathman::prepend_to_path;

prepend_to_path("/Users/nicolas/.biome/bin", Some("Biome installation directory"));
```

### Appending a directory to the `PATH`

Use the `append_to_path` function to add a directory to the end of the
`PATH` environment variable. This is useful for adding directories that contain
executables that you want to be available system-wide, but not necessarily
searched first. An optional comment can also be specified, which will be added 
to the shell configuration file on macOS and Linux.

```rust
use pathman::append_to_path;

append_to_path("/Users/nicolas/.biome/bin", Some("Biome installation directory"));
```

## License

Pathman is licensed under either of:

- The [Apache License Version 2.0](LICENSE-APACHE)
- The [MIT License](LICENSE-MIT)

at your option.

### Contributions

<small>Unless you explicitly state otherwise, any contribution intentionally submitted for
inclusion in this crate by you, as defined in the [Apache-2.0 license](LICENSE-APACHE),
shall be dual licensed as above, without any additional terms or conditions.</small>