https://github.com/tamada/sibling
get next/previous sibling directory name.
https://github.com/tamada/sibling
bash directory-traversal utility
Last synced: 5 months ago
JSON representation
get next/previous sibling directory name.
- Host: GitHub
- URL: https://github.com/tamada/sibling
- Owner: tamada
- License: wtfpl
- Created: 2020-06-05T03:01:09.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-07-18T08:31:43.000Z (12 months ago)
- Last Synced: 2025-10-08T19:46:37.835Z (9 months ago)
- Topics: bash, directory-traversal, utility
- Language: Rust
- Homepage: https://tamada.github.io/sibling
- Size: 215 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sibling
[](https://github.com/tamada/sibling/actions/workflows/build.yaml)
[](https://coveralls.io/github/tamada/sibling?branch=main)
[](https://rust-reportcard.xuri.me/report/github.com/tamada/sibling)
[](https://crates.io/crates/sibling)
[](https://github.com/tamada/sibling/blob/master/LICENSE)
[](https://github.com/tamada/sibling/releases/tag/v2.0.4)
get the next/previous sibling directory name.
## :speaking_head: Description
When a directory has too many sub-directories, we are tiresome to traverse the whole of sub-directories.
Because, sometimes we lose where we are.
Ideally, we move the directory by specifying ‘next’ or ‘previous,' not the directory name.
The command like the following makes us tired :-1:.
cd ../next_directory_name
We should type the command like below :+1:.
cdnext
For this, I implemented `sibling`.
## Utility commands
The `sibling` introduces the following utility commands.
- change the working directory to the sibling directory:
- `cdnext`,
- `cdprev`,
- `cdfirst`,
- `cdlast`, and
- `cdrand`
- list the sibling directory:
- `lsnext`,
- `lsprev`,
- `lsfirst`,
- `lslast`, and
- `lsrand`
The `cdnext` and the `cdprev` allow the integer argument to repeat the traversing.
## :runner: Usage
`sibling` prints the next directory name with 0 status code.
The next directory is decided by the traversing type. Available values are: `next`, `previous`, `first`, `last`, `keep` and `random`, default is `next`.
After visiting the final directory, the `sibling` prints nothing and exits with a non-zero status code.
## :anchor: Installation
### :beer: Homebrew
Install `sibling` via [Homebrew](https://brew.sh), simply run:
```bash
brew tap tamada/brew
brew install sibling
```
And put the following snipeets into your shell profile (e.g., `.bash_profile`, or `.zshrc`)
The `--init` option accepts only `bash`.
Other shell scripts are not supported, yet.
```bash
eval "$(sibling --init bash)"
```
### :muscle: Compiling yourself
Get source codes by `git clone` or download from [GitHub](https://github.com/tamada/sibling),
then run `cargo build` to build `sibling`.
```shell
git clone https://github.com/tamada/sibling.git # or download from https://github.com/tamada/sibling
cd sibling
cargo build --release # the binary file is put on target/release/sibling.
```
## :smile: About the project
### :scroll: License
- [WTFPL](https://github.com/tamada/sibling/blob/master/LICENSE)
- :+1: Commercial use
- :+1: Modification
- :+1: Distribution
- :+1: Private use
### :man_office_worker: Developers :woman_office_worker:
- [Haruaki Tamada](https://tamada.github.io)
### :link: Useful links for directory traversing
- [cdargs](https://github.com/cbxbiker61/cdargs)
- Directory bookmarking system - Enhanced cd utilities
- [Is there a directory history for bash?](https://superuser.com/questions/299694/is-there-a-directory-history-for-bash)