Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.51 KB

README.md

File metadata and controls

46 lines (33 loc) · 1.51 KB
Raw
Submod Surfer logo

Surf through the submodules of your project with ease!

Installation

  1. Build the submod_surfer crate (cargo build --release).
  2. Modify subsurfer.sh, replacing <INSTALL_PATH> with a path to the binary from step 1.

Usage

The submod_surfer binary isn't intended to be used directly. Rather, it only handles the user fuzzy finding over the submodules in 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 subsurfer.sh script to change into the desired directory. In order to use this tool, please source the subsurfer.sh script. Any arguments passed while sourcing the script will be forwarded to the binary as one would expect.

$ submod_surfer --help
Usage: submod_surfer [OPTIONS]

Options:
  -m, --module-path <MODULE_PATH>  Path to the .gitmodules file of interest
  -f, --fmt <FMT>                  Default: "%n", Name: %n or %N, Path: %p, Url: %u, Branch: %b
  -h, --help                       Print help

$ source /path/to/subsurfer.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,

alias other_surf="source /path/to/subsurfer.sh --module-path /absolute/path/to/project"

TODO

  • Add more tests
  • Address user feedback