https://github.com/essentialkaos/path
Dead simple tool for working with paths
https://github.com/essentialkaos/path
coreutils utility
Last synced: 8 months ago
JSON representation
Dead simple tool for working with paths
- Host: GitHub
- URL: https://github.com/essentialkaos/path
- Owner: essentialkaos
- License: apache-2.0
- Created: 2023-05-02T20:26:10.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-03T11:28:51.000Z (12 months ago)
- Last Synced: 2025-03-03T12:32:09.828Z (12 months ago)
- Topics: coreutils, utility
- Language: Go
- Homepage: https://kaos.sh/path
- Size: 260 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Installation • Command-line completion • Man documentation • Usage • CI Status • Contributing • License
`path` is a dead simple tool for working with paths. This tool provides commands which you can use to replace such tools as `basename`, `dirname`, and `readlink` and many more. But unlike these tools, `path` allows you to pass input not only as arguments, but also using standard input (_for example with pipes_). It's easy to use and doesn't require to know all this kung-fu with `find` or `xargs`.
Simple examples:
```bash
find . -iname '*.txt' -print0 | xargs -0 -n1 -- basename
# or
find . -iname '*.txt' | xargs -L1 -I{} basename "{}"
# with path
find . -iname '*.txt' | path basename
```
```bash
# Note that there is two spaces between {} and \; and if you forget
# about this it will don't work. Also in this case we will run 'basename'
# for each item in find output.
find . -mindepth 1 -maxdepth 1 -type d -exec basename {} \;
# with path
find . -mindepth 1 -maxdepth 1 -type d | path basename
```
Also, it works **MUCH** faster (~120x):
```
$ git clone https://github.com/kubernetes/kubernetes.git --depth=1
$ cd kubernetes
$ hyperfine 'find . -iname *.go -print0 | xargs -0 -n1 -- basename' 'find . -iname *.go | path basename'
Benchmark 1: find . -iname *.go -print0 | xargs -0 -n1 -- basename
Time (mean ± σ): 12.621 s ± 0.077 s [User: 5.871 s, System: 7.043 s]
Range (min … max): 12.512 s … 12.745 s 10 runs
Benchmark 2: find . -iname *.go | path basename
Time (mean ± σ): 106.5 ms ± 1.5 ms [User: 59.8 ms, System: 60.4 ms]
Range (min … max): 104.1 ms … 111.1 ms 28 runs
Summary
find . -iname *.go | path basename ran
118.45 ± 1.80 times faster than find . -iname *.go -print0 | xargs -0 -n1 -- basename
```
### Installation
#### From source
To build the `path` from scratch, make sure you have a working [Go 1.23+](https://github.com/essentialkaos/.github/blob/master/GO-VERSION-SUPPORT.md) workspace (_[instructions](https://go.dev/doc/install)_), then:
```
go install github.com/essentialkaos/path@latest
```
#### From [ESSENTIAL KAOS Public Repository](https://kaos.sh/kaos-repo) for EL 8/9
```bash
sudo dnf install -y https://pkgs.kaos.st/kaos-repo-latest.el$(grep 'CPE_NAME' /etc/os-release | tr -d '"' | cut -d':' -f5).noarch.rpm
sudo dnf install path
```
#### Prebuilt binaries
You can download prebuilt binaries for Linux and macOS from [EK Apps Repository](https://apps.kaos.st/path/latest):
```bash
bash <(curl -fsSL https://apps.kaos.st/get) path
```
### Command-line completion
You can generate completion for `bash`, `zsh` or `fish` shell.
Bash:
```bash
sudo path --completion=bash 1> /etc/bash_completion.d/path
```
ZSH:
```bash
sudo path --completion=zsh 1> /usr/share/zsh/site-functions/path
```
Fish:
```bash
sudo path --completion=fish 1> /usr/share/fish/vendor_completions.d/path.fish
```
### Man documentation
You can generate man page using next command:
```bash
path --generate-man | sudo gzip > /usr/share/man/man1/path.1.gz
```
### Usage
### CI Status
| Branch | Status |
|--------|----------|
| `master` | [](https://kaos.sh/w/path/ci?query=branch:master) |
| `develop` | [](https://kaos.sh/w/path/ci?query=branch:develop) |
### Contributing
Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/.github/blob/master/CONTRIBUTING.md).
### License
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
