Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohamedelashri/ndpath
A command-line tool for managing and editing the PATH environment variables
https://github.com/mohamedelashri/ndpath
environment-variables pathos
Last synced: 12 days ago
JSON representation
A command-line tool for managing and editing the PATH environment variables
- Host: GitHub
- URL: https://github.com/mohamedelashri/ndpath
- Owner: MohamedElashri
- License: mit
- Created: 2024-04-02T18:02:28.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-03T06:47:43.000Z (10 months ago)
- Last Synced: 2024-12-14T08:44:31.735Z (about 1 month ago)
- Topics: environment-variables, pathos
- Language: Python
- Homepage: https://pypi.org/project/ndpath/
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/MohamedElashri/ndpath/actions/workflows/tests.yml)
# ndpath
ndpath is a command-line tool for managing and editing the `PATH` environment variables. It provides an interactive interface to view, add, remove, and reorder directories in your PATH.
## Introduction
ndpath is a Python port of the [pathos](https://github.com/chip/pathos) tool, which is written in Go. As the maintainer of ndpath, my motivation for creating this port is that I don't have sufficient knowledge of Go to contribute to the upstream development of pathos. Therefore, ndpath is intended to be a hard fork rather than a soft fork, allowing for independent development and maintenance.
## Installation
To install ndpath, you need to have Python installed on your system. You can install ndpath using pip:
```bash
pip install ndpath
```
## Usage
To use ndpath, simply run the following command in your terminal:
```
ndpath
```
This will launch the interactive interface of ndpath that will allow you to view, add, remove, and reorder paths in your `PATH`. You should also source the `.pathos.env` file in your shell configuration file (e.g., `.bashrc`, `.zshrc`, etc.) to load the modified `PATH` into your shell environment.
```bash
source ~/.pathos.env
```
## Features
ndpath provides the following features:
- View the current list of directories in your `PATH`
- Add new directories to your `PATH`
- Remove directories from your `PATH`
- Reorder directories in your `PATH`
- Save changes to your `PATH` permanently
## Keyboard Shortcuts
ndpath supports the following keyboard shortcuts:
- `q` - Quit the program (you will be prompted to save changes)
- `k` or `↑` - Move the selection cursor up
- `j` or `↓` - Move the selection cursor down
- `o` - Insert a new directory below the selected directory
- `O` - Insert a new directory above the selected directory
- `x` - Delete the selected directory
- `X` - Delete all non-existent directories from your `PATH`
- `D` - Deduplicate the list of directories in your `PATH`
- `S` - Manually save changes to your `PATH`
## Configuration
ndpath stores the modified `PATH` in a file named `.ndpath.env` in your home directory.
This file is loaded by ndpath on startup and is updated whenever you save changes to your PATH.
## Contributing
Contributions to ndpath are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.
## License
ndpath is released under the MIT License. See the [LICENSE](LICENSE) file for more information.
## Acknowledgements
ndpath is inspired by and based on the [pathos](https://github.com/chip/pathos) tool. Special thanks to the creators and contributors of pathos for their work.