Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cjus/godir
Goto Directory - Fuzzy CD command
https://github.com/cjus/godir
Last synced: 10 days ago
JSON representation
Goto Directory - Fuzzy CD command
- Host: GitHub
- URL: https://github.com/cjus/godir
- Owner: cjus
- License: mit
- Created: 2024-12-12T17:57:06.000Z (21 days ago)
- Default Branch: main
- Last Pushed: 2024-12-12T19:26:46.000Z (21 days ago)
- Last Synced: 2024-12-12T19:29:55.862Z (21 days ago)
- Language: Rust
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# godir
Goto Directory - A fuzzy directory navigation tool for command line Ninjas
Very early in my career, I built a command line utility in C/Assembly called `gd` - "go directory" that allowed me to navigate to directories based on patterns. I've been missing that little tool ever since. So, I rebuilt it in Rust.
Godir supports direct navigation using relative or absolute paths:
```sh
godir ../projects # Navigate to relative path
godir /Users/name/dev # Navigate to absolute path
godir ~/dev/project # Navigate using shell expansion
```
When using a path (instead of a pattern), godir will:
1. Expand the path to its full canonical form
2. Verify it's a valid directory
3. Add it to the configuration file if not already present
4. Navigate to the directory
This makes it easy to add new directories to your configuration while navigating to them.
## Other examples
```sh
godir . # Matches the current directory and adds it to the configuration file
godir dev # Matches any directory containing "dev"
godir ^/Users # Matches directories starting with "/Users"
godir project$ # Matches directories ending with "project"
godir dev/./src # Matches paths containing "dev/" followed by any characters, then "/src"
godir 'test|prod' # Matches directories containing either "test" or "prod"
godir 'lionheart.*crons' # Matches directories containing "lionheart" followed by any characters, then "crons": ~/dev/lionheart-backend/Lionheart-Boreal/app/crons
```
## Pattern Expressions
Godir supports Regex pattern matching expressions:
### Basic Patterns
- `foo` - Matches any directory containing "foo"
- `^foo` - Matches directories that start with "foo"
- `foo$` - Matches directories that end with "foo"
- `foo|bar` - Matches directories containing either "foo" or "bar"
### Directory Path Patterns
- `dev/foo` - Matches directories containing "dev/foo"
- `/Users/name` - Matches exact path segments
- `^/Users/name` - Matches paths starting from root
### Special Characters
- `.` - Matches any single character
- `.*` - Matches zero or more of any character
- `\w` - Matches word characters (letters, digits, underscore)
- `\d` - Matches digits
- `\s` - Matches whitespace
## Installation
On Mac's you can brew install godir.
```sh
brew tap cjus/godir
brew install godir
```
Make sure to follow the post install instructions.
Prebuilt binaries are also available for macOS, Linux, and Windows in the [releases](https://github.com/cjus/godir/releases) section. Download the appropriate binary for your system and add it to your PATH.
### Unix-based Systems (macOS/Linux)
To ensure `godir` can change the current shell directory, add this shell function to your shell's configuration file (~/.bashrc, ~/.zshrc, etc.):
Replace `PATH_TO_GODIR` with the path to the `godir` binary.
```sh
godir() {
local output
output="$(command PATH_TO_GODIR/godir "$@")"
if [ $? -eq 0 ]; then
if [[ "$1" == "--help" ]] || [[ "$1" == "-h" ]] || [[ "$1" == "--version" ]] || [[ "$1" == "-V" ]] || [[ "$1" == "--list" ]] || [[ "$1" == "-l" ]]; then
echo "$output"
elif [ -n "$output" ]; then
cd "$output"
fi
fi
}
```
### Windows
For Windows PowerShell, add this function to your PowerShell profile (usually at `$PROFILE`):
```powershell
function godir {
$output = & godir.exe $args
if ($LASTEXITCODE -eq 0) {
if ($args -contains "--help" -or $args -contains "-h" -or $args -contains "--version" -or $args -contains "-V" -or $args -contains "--list" -or $args -contains "-l") {
Write-Output $output
}
elseif ($output) {
Set-Location $output
}
}
}
```
Then reload your shell configuration:
- Unix: `source ~/.bashrc` (or ~/.zshrc)
- Windows: `. $PROFILE`
## Usage
```sh
godir
```
Pro Tip: to quickly add the current directory to the configuration file, use the `.` pattern.
```sh
godir .
```
---
## Usage tips
The `godir` command maintains an editable configuration file. You can find the `directories.json` file in the `.godir` directory under the user's home directory. The configuration file is used to store the directories that `godir` knows about.
Here's an example of what the `directories.json` file looks like:
```json
{
"directories": [
"/Users/cjus/dev/commercial",
"/Users/cjus/dev/commercial/apps/demo-redis",
"/Users/cjus/dev/godir",
"/Users/cjus/dev/moose",
"/Users/cjus/dev/moose_redis",
"/Users/cjus/dev/redis-user-create"
],
"excludes": [
".git",
".next",
"/Applications",
"/cores",
"/Library",
"/private",
"/System",
"/usr",
"/var",
"/Volumes",
"dist",
"iCloud",
"node_modules",
"target"
]
}
```
Manually edit the configuration file to add or remove directories.
To exclude directories, add related patterns to the `excludes` array.
Notes:
* If you use a pattern that `godir` doesn't reconize then it will give you the option to add a directory path on the spot or ask if you'd like it to perform a full directory scan. It will then add the directory path(s) it matches to the configuration file.
* After a full directory scan, you should edit the `~/.godir\directories.json` file to cleanup any entries that you don't care about. You can also add patterns to the `excludes` array to exclude directories from future scans.
Remember, to quickly add the current directory to the configuration file, use the `.` pattern.
```sh
godir .
```