Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rickstaa/.pathmod
A bash script that makes it easier to view and modify the PATH and PYTHONPATH environment variables
https://github.com/rickstaa/.pathmod
Last synced: about 1 month ago
JSON representation
A bash script that makes it easier to view and modify the PATH and PYTHONPATH environment variables
- Host: GitHub
- URL: https://github.com/rickstaa/.pathmod
- Owner: rickstaa
- License: mit
- Created: 2020-01-06T14:54:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-24T11:15:55.000Z (over 2 years ago)
- Last Synced: 2024-05-01T16:39:08.666Z (7 months ago)
- Language: Shell
- Homepage:
- Size: 43.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Path modification bash script
[](https://www.codacy.com/gh/rickstaa/.pathmod/dashboard?utm_source=github.com&utm_medium=referral&utm_content=rickstaa/.pathmod&utm_campaign=Badge_Grade)
[](https://github.com/rickstaa/pathmod/pulse)
[](contributing.md)
The pathmod bash script makes it easier to view and modify the PATH and PYTHONPATH environment variables. It comes with an easy command-line interface which allows you to:
- Display the paths that are on the PATH and PYTHONPATH in a more readable format.
- Check whether a path is on the PATH or PYTHON.
- Delete a path from the PATH or PYTHONPATH.
- Add a path from the PATH or PYTHONPATH.
- Move a path to a different position in the PATH or PYTHONPATH.
## How to setup
### Automatic installation
1. Clone the repository to your user home directory and cd into the `.pathmod` folder.
```bash
git clone https://github.com/rickstaa/.pathmod.git
cd .pathmod
```
2. Run the `install.sh` script to install the ROS Conda wrapper.
### Manual installation
1. Create a symbolic link to the `.pathmod_rc` file:
```bash
ln -fs "$(pwd)/.pathmod_rc" "$(echo $HOME)/.pathmod_rc"
```
2. Add the following code at the end of your `.bashrc`.
```sh
# >>> pathmod initialize >>
## Source pathmod script
if [ -f "$HOME/.pathmod_rc" ]; then
. "$HOME/.pathmod_rc"
fi
# <<< pathmod initialize <<<
```
## How to uninstall
To uninstall the pathmod script run the `uninstall.sh` script before removing the `.pathmod` repository.
## How to use
### Pathmod commands
The pathmod script takes the following commands:
- `-a --add`: Add path(s) to the PATH or PYTHONPATH
- `-i --index:` Specify the index where to add the path(s) (OPTIONAL: 0=start, -1=end, defaults to -1)
- `-m --move`: Move a path to a given index (Adds path if not yet present.)
- `-r --remove`: Remove path(s) from the PATH or PYTHONPATH
- `-c --check`: Check if path exists in the PATH or PYTHONPATH
- `-h --help`: Display help
- `-p --pythonpath`: Modify PYTHONPATH instead of PATH
- `-v, --version`: Show pathmod version
- `-s --settings`: List pathmod settings and the current PATH and PYTHONPATH
- `-sd --set-path-display`: Display PATH and PYTHONPATH after each command (OPTIONAL, defaults to false)
- `-se --set-export`: Export path after it is set (OPTIONAL, defaults to true)
- `-sg --set-path-guard`: Check whether a path is valid before adding it (OPTIONAL, defaults to false)
:information_source: **NOTE:** Each option only accepts one argument at the same time. To add, remove or check multiple
paths please use the colon (Example: `pathmod -- :`) or space separator (Example: `pathmod -- " "`).
#### Examples
##### Add path to PATH variable
```bash
pathmod --add
```
##### Add path to PATH at an index
```bash
pathmod --add --index
```
##### Remove path from PATH variable
```bash
pathmod --remove
pathmod --remove
```
##### Check if path exists in PATH variable
```bash
pathmod --exists
```
##### Move path to a given index
```bash
pathmod --move --index
pathmod --move --index
```
##### Add path from PYTHONPATH variable
```bash
pathmod --pythonpath --add
```
## Issues
Please feel free to open [an issue](https://github.com/rickstaa/.pathmod/issues) if you run into problems or have suggestions.
## Contributing
Feel free to open an issue if you have ideas on how to make this GitHub action better or if you want to report a bug! All contributions are welcome. :rocket: Please consult the [contribution guidelines](CONTRIBUTING.md) for more information.
## License
[MIT](LICENSE)