From 29a9a16a4bb33d0546b8a1e286f88c902828c57b Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Thu, 2 Nov 2023 09:58:56 -0600 Subject: [PATCH] doc(pathman): add shell config info, cheat sheet, and add ToC --- pathman/README.md | 50 ++++++++++++++++++++++++++++++++++------------- 1 file changed, 36 insertions(+), 14 deletions(-) diff --git a/pathman/README.md b/pathman/README.md index 0146ddb..c734628 100644 --- a/pathman/README.md +++ b/pathman/README.md @@ -5,12 +5,39 @@ tagline: | Pathman: cross-platform PATH management for bash, zsh, fish, cmd.exe, and PowerShell. --- -## Updating `pathman` +To update or switch versions, run `webi pathman@stable` (or `@v0.5`, `@beta`, +etc). + +## Cheat Sheet + +Manages PATH on various OSes and shells + +- Mac, Windows, Linux +- POSIX Shell, Bash, Zsh, Fish +- Command, Powershell ```sh -webi pathman +pathman add ~/bin/ ``` +
+Saved changes to ~/.config/envman/PATH.env
+
+Copy, paste, and run the following command:
+
+    PATH="$HOME/bin:$PATH"
+
+(newly opened terminal windows will have the updated PATH)
+
+ +**Windows Users**: use POSIX-style `/` (for paths) and `~` (for +`%USERPROFILE%`) - they'll be adjusted automatically. + +## Table of Contents + +- Files +- Add, Remove, List, etc + ### Files These are the files / directories that are created and/or modified with this @@ -19,22 +46,20 @@ install: ```text ~/.config/envman/PATH.env ~/.local/bin/pathman + +# 'source ~/.config/envman/PATH.env' will be added to +~/.profile +~/.bashrc +~/.zshrc +~/.config/fish/config.fish ``` -## Cheat Sheet - -Manages PATH on various OSes and shells - -- Mac, Windows, Linux -- Bash, Zsh, Fish -- Command, Powershell +### Usage ```sh pathman help ``` -### Usage - ```sh pathman add ~/.local/bin ``` @@ -43,9 +68,6 @@ pathman add ~/.local/bin pathman remove ~/.local/bin ``` -Note: Even on Windows it is best to use Unix-style `/` paths and `~` for -`%USERPROFILE%`. - ```sh pathman list ```