aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
blob: 447643ea028f9461b60288b487a046462bc5c574 (plain) (blame)
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
Windows environment variables
=============================

[![CI](https://github.com/egor-tensin/windows-env/workflows/CI/badge.svg)](https://github.com/egor-tensin/windows-env/actions?query=workflow%3ACI)

A collection of simple utilities to manage Windows environment variables,
created mainly to:

* learn a bit of Haskell,
* make it easier to add directories to the `PATH` variable, list missing
directories in your `PATH`, etc.

Building
--------

Using [stack]:

```
> stack setup
...

> stack build
...
```

[stack]: http://docs.haskellstack.org/en/stable/README/

To prepare for making a release the following commands might be useful:

```
> stack build --install-ghc --copy-bins --local-bin-path ..\windows-env-x86 --arch i386
...

> stack build --install-ghc --copy-bins --local-bin-path ..\windows-env-x64 --arch x86_64
...
```

Installation
------------

```
> stack install
...
```

Usage
-----

The complete list of utilities is given below.

* [paths] — List directories in your `PATH`.
* [addpath] — Add directories to `PATH`.
* [delpath] — Remove directories from `PATH`.
* [setenv] — Assign values to environment variables.
* [delenv] — Delete environment variables.

Pass the `--help` flag to an utility to examine its detailed usage information.
Some examples are given below.

[paths]: #paths
[addpath]: #addpath
[delpath]: #delpath
[setenv]: #setenv
[delenv]: #delenv

### paths

List directories in your `PATH`:

```
> paths
C:\Program Files\Haskell\bin
C:\Program Files\Haskell Platform\8.0.1\lib\extralibs\bin
C:\Program Files\Haskell Platform\8.0.1\bin
C:\Users\Egor\AppData\Roaming\local\bin
C:\Users\Egor\AppData\Roaming\cabal\bin
...
```

Only list missing directories in your `PATH`:

```
> paths --missing
C:\Users\Egor\AppData\Roaming\cabal\bin
...
```

### addpath

Add "C:\test" to current user's `PATH`:

```
> addpath C:\test
Saving variable 'PATH' to 'HKCU\Environment'...
        Old value: C:\Users\Egor\AppData\Roaming\local\bin;C:\Users\Egor\AppData\Roaming\cabal\bin
        New value: C:\Users\Egor\AppData\Roaming\local\bin;C:\Users\Egor\AppData\Roaming\cabal\bin;C:\test
Continue? (y/n) y
```

Add "C:\test" to the global `PATH`, skipping the confirmation prompt:

```
> addpath --global -y C:\test
```

### delpath

Remove "C:\test" from current user's `PATH`:

```
> delpath C:\test
Saving variable 'PATH' to 'HKCU\Environment'...
        Old value: C:\Users\Egor\AppData\Roaming\local\bin;C:\Users\Egor\AppData\Roaming\cabal\bin;C:\test
        New value: C:\Users\Egor\AppData\Roaming\local\bin;C:\Users\Egor\AppData\Roaming\cabal\bin
```

Remove "C:\test" from both current user's and the global `PATH`s, skipping the
confirmation prompt:

```
> delpath --global -y C:\test
```

### setenv

Assign `bar` to the variable `foo` in current user's environment, skipping the
confirmation prompt:

```
> setenv -y foo bar
```

Assign `bar` to the variable `foo` in the global environment:

```
> setenv --global foo bar
Saving variable 'foo' to 'HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment'...
        New value: bar
Continue? (y/n) y
```

### delenv

Delete the variable `foo` from current users's environment, skipping the
confirmation prompt:

```
> delenv -y foo
```

Delete the variable `foo` from the global environment:

```
> delenv --global foo
Deleting variable 'foo' from 'HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment'...
Continue? (y/n) y
```

License
-------

Distributed under the MIT License.
See [LICENSE.txt] for details.

[LICENSE.txt]: LICENSE.txt