https://github.com/willlillis/submod_surfer
Fuzzy find to navigate through the submodules of a git project
https://github.com/willlillis/submod_surfer
command-line-tool developer-tools git
Last synced: about 2 months ago
JSON representation
Fuzzy find to navigate through the submodules of a git project
- Host: GitHub
- URL: https://github.com/willlillis/submod_surfer
- Owner: WillLillis
- License: mit
- Created: 2024-11-10T19:01:50.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-02T06:20:57.000Z (over 1 year ago)
- Last Synced: 2025-12-03T12:19:49.111Z (7 months ago)
- Topics: command-line-tool, developer-tools, git
- Language: Rust
- Homepage:
- Size: 719 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#
Surf through the submodules of your project with ease!
# Installation
1. Build the `submod_surfer` crate (`cargo build --release`).
2. `source env.sh`
# Usage
The `submod_surfer` binary isn't intended to be invoked directly. Rather, it only
handles the user's fuzzy finding over the submodules of their git project. Once a
choice has been made, the program outputs the path to said submodule and exits.
This path is then used by the shell function defined in `env.sh` script to change
into the desired directory. In order to use this tool, please *source* the `env.sh`
script.
```
$ submod_surfer --help
Usage: submod_surfer [OPTIONS]
Options:
-m, --module-path Path to the .gitmodules file of interest
-f, --fmt Default: "%n", Name: %n or %N, Path: %p, Url: %u, Branch: %b
-h, --help Print help
$ source /path/to/env.sh
```
That's it! It's common to utilize the `module-path` argument alongside a shell alias
so you can surf even while outside of your project's root directory. For example,
```shell
alias surf="submod_surfer --module-path /absolute/path/to/project --fmt %p"
```
## TODO
- The tool does not work inside git bash's terminal emulator. This needs to be investigated further
- More cleanup with shell integration (Shells besides zsh and Bash)
- Add more tests
- Address user feedback