Skip to content

Commit

Permalink
docs: --follow-symlinks flag mentioned for #11
Browse files Browse the repository at this point in the history
  • Loading branch information
epogrebnyak committed Feb 28, 2024
1 parent b6097e1 commit cac4a4a
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,14 @@ Just a simple utility to explore `PATH` environment variable on both Windows and

## Workflow

`justpath` shows your `PATH` environment variable line by line with numbering, additional comments and
color. You can also create a modified version of `PATH` (e.g. by excluding non-existent directories)
`justpath` shows your `PATH` environment variable line by line with numbering, comments and color.
You can also create a modified version of `PATH` (e.g. by excluding non-existent directories)
and use this new string to set `PATH` in your shell startup script or using an environment manager.

Note that neither `justpath` nor any child process cannot hot change your shell `PATH` directly.
Note that neither `justpath` nor any child process cannot change your shell `PATH` directly.

My own use case for `justpath` was exploring and sanitizing the `PATH` on Windows
after each and every program was attempting to change it.
I also find it useful to inspect `PATH` on a remote enviroment like Codespaces
to detect invalid paths.
My own use case for `justpath` was exploring and sanitizing the `PATH` on Windows (together with Rapid Environment Editor).
I also find it useful to inspect `PATH` on a remote enviroment like Codespaces to detect invalid paths.

## Try quickly

Expand Down Expand Up @@ -180,6 +178,9 @@ Use `--invalid` flag to explore what parts of PATH do not exist or not a directo
`--correct` flag is the same as applying both `--purge-invalid` and `--purge-duplicates`
flag. The duplicates are purged from the end of a string.

You may also add `--follow-symlinks` flag in order to resolve symbolic links
when counting and purging duplicate directories.

### 4. Dump `PATH` as JSON

`justpath` can dump a list of paths from `PATH` to JSON.
Expand Down

0 comments on commit cac4a4a

Please sign in to comment.