windows-env 0.2.1

Easily manage Windows environment variables permanently.
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

# windows-env


Easily manage Windows environment variables **permanently**, without the need to restart your system. (**but terminal restart is required**)

Features:

- Easily operate list variables like `PATH`.

## Installation


- as lib:
  ```toml
  [target."cfg(windows)".dependencies]
  windows_env = "0.2.0"
  ```
- as executable binary:
  ```sh
  cargo binstall windows-env        # see cargo-binstall: https://github.com/cargo-bins/cargo-binstall

  cargo install windows-env -F bin  # or compile from source manually

  ```

## Example


- binary usage: runs `wenv -h` to see help message.
- lib usage:

  ```rs
  fn main() -> std::io::Result<()> {
      windows_env::set("TEST_ENV", "test")?;
      assert_eq!(windows_env::get("TEST_ENV")?.unwrap(), "test");
      windows_env::remove("TEST_ENV")?;
      assert!(windows_env::get("TEST_ENV")?.is_none());

      windows_env::append("TEST_ENV", "test1")?;
      windows_env::prepend("TEST_ENV", "test2")?;
      assert_eq!(windows_env::get("TEST_ENV")?.unwrap(), "test2;test1");

      windows_env::remove_from_list("TEST_ENV", "test2")?;
      assert!(windows_env::exists_in_list("TEST_ENV", "test1")?);

      windows_env::remove("TEST_ENV")?;
      Ok(())
  }
  ```

  - using windows-env as a lib will affect the current process, so you can use the new env by spawning processes after modifying env in rust code.

## Compare


- [set_env](https://crates.io/crates/set_env):
  - it uses powershell script while this crate uses windows api

## TODO


- [x] cli support
- [ ] System env modification

## MSRV


- v0.1.1: 1.70