Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chetanxpro/jump
A CLI tool to manage and navigate directories quickly.
https://github.com/chetanxpro/jump
Last synced: about 6 hours ago
JSON representation
A CLI tool to manage and navigate directories quickly.
- Host: GitHub
- URL: https://github.com/chetanxpro/jump
- Owner: ChetanXpro
- License: mit
- Created: 2024-06-19T03:36:03.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-06-22T11:00:56.000Z (5 months ago)
- Last Synced: 2024-11-13T04:10:59.673Z (2 days ago)
- Language: Rust
- Size: 63.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jumb: Simplify Directory Navigation
How many times do you run the `cd` command in a day? If you're like many developers, it's probably more than you'd like to count.
**Jumb** is a command-line tool that simplifies directory navigation by allowing users to create shortcuts for frequently accessed directories. This reduces the need for lengthy `cd` commands, saving time and streamlining workflow.
## Key Benefits
- **Reduce `cd` Usage**: Minimize the need to use lengthy `cd` commands by setting up shortcuts to your most used directories.
- **Save Time**: Dramatically reduce the time spent navigating between different parts of your file system, enhancing productivity, especially for developers and system administrators.
- **Streamline Workflow**: Improve your workflow efficiency by quickly switching contexts between projects and directories.
## Prerequisites
Before installing Jumb, ensure you have the following installed on your system:
- **Git**: Required to clone the repository if not installing via Cargo.
- **Rust and Cargo**: Jumb is built with Rust, so you'll need Rust and Cargo installed to compile and install it directly from the source or via Cargo. Install them from [the official Rust site](https://www.rust-lang.org/tools/install).
## Installation
### Using Cargo
Install Jumb directly from Cargo:
```bash
cargo install jumb
```
**NOTE**: After installing Jumb with Cargo, it's essential to wrap it with a shell script to make the tool work properly.
### Setting Up the Shell Wrapper
Integrate Jumb with your shell by adding a shell wrapper to your .zshrc or .bashrc file. This wrapper ensures that using Jumb feels like a natural extension of your shell commands.
```bash
# Jumb tool wrapper
function jnav() {
unalias jumb 2>/dev/null
unset -f jumb 2>/dev/null
# Find the path to the 'jumb' executable dynamically
local jumb_path=$(which jumb)
if [[ -z "$jumb_path" ]]; then
echo "The 'jumb' command is not installed or not in PATH."
return 1 # Exit the function with an error status
fi
# Check if the command is 'view' without additional arguments
if [[ "$1" == "view" ]] && [[ $# -eq 1 ]]; then
# This should only list the directories, not change to any directory
$jumb_path view
elif [[ $# -eq 1 ]]; then
# Assuming any single argument not prefixed by 'view' is a path name
local dir=$($jumb_path "$1")
if [[ -d "$dir" ]]; then
cd "$dir"
else
echo "Directory not found: $dir"
fi
else
# Handle other commands or multiple arguments normally
$jumb_path "$@"
fi
}
```
### Why Use ``jnav`` Instead of ``jumb``?
The ``jnav`` function is used instead of directly invoking jumb to avoid any potential conflicts with the binary name. This function ensures that the shell correctly handles the custom functionality provided by Jumb, such as managing and navigating to directory shortcuts.
### Customizing Function Name
If you prefer a different name for the function, replace jnav with your chosen name to prevent potential conflicts with the Jumb binary.
## Usage
Set up and manage your directory shortcuts easily:
- Add a Shortcut
```bash
jnav add shortcut_name absolute/path/to/directory
```
For example, if you want to add the current directory path, then you can run the command with a full stop to add the current dir.
```bash
jnav add project .
```
- Navigate quickly using:
```bash
jnav shortcut_name
```
- Remove a Shortcut
```bash
jnav remove shortcut_name
```
- View All Shortcuts
```bash
jnav view
```
- View particular shortcut path
```bash
jnav view
```
## Contributing
Contributions are encouraged. Feel free to fork the project and submit pull requests.