#  magoo
**In Development. commands left are: install, update, remove**
This  is Magoo, he helps you manage git submodules with ease, like `npm` or `cargo`, but for submodules.
Adding a submodule is easy, but have you ever struggled with:
- How do I update a submodule?
- How do I delete a submodule?
- How do I tell my colleagues how to update their submodules after I update them????
 saves all of us by running the `git` commands for us. He figures out
all the relevant information from the git repository itself. There's no extra files
required and  works out of the box for all git repos with submodules.
 **does not like pipelines**. Please simply let your pipeline
checkout the submodules (recursively if needed). For example, if you are using GitHub Actions:
```yaml
- uses: actions/checkout@v4
with:
submodules: recursive
```
## Install 
###  As a CLI tool
```
cargo install magoo
```
###  As a library
To include  in your rust application, add it as a depedency. See https://docs.rs/magoo for more info.
## Use 
 runs `git` commands using sub-processes, so you must have `git` installed on the system.
You can run `magoo status --git` to check what version you have on your system, as well as
the officially supported `git` versions. Unsupported versions might work as well,  just doesn't know.
### Add a submodule
To add a submodule,  needs to know:
- `URL`: The git URL like https://github.com/owner/repo
- `PATH`: The path in your repo the module should be at
- Optionally, `BRANCH`: The branch to update to when you run `magoo update`
It's recommended to always specify the `BRANCH`. Git by default will use the `HEAD` branch, which
is usually not what you want.
```bash
magoo install URL PATH --branch BRANCH
magoo install URL PATH --branch BRANCH --name NAME --depth DEPTH --force
```
Run `magoo install help` to see other options
### Initialize the submodules
```bash
magoo install
```
This will ensure the submodules are cloned/updated to the commit stored in the index.
You should run `magoo install` every time you pull - similar to `npm install`.
It also deletes submodules that are deleted by others.
### Show submodule status
```bash
magoo status
magoo status --fix
```
Shows everything  knows about submodules in the current repo.
If you have tinkered with submodules yourself,  might not like the state since
there could be inconsistencies.  will tell you what he doesn't like, and the `--fix` option will fix those.
### Update submodules
 updates the submodule by fetching and checking out the latest updates from the remote, tracked by
the `BRANCH` specified when you add it.
- Update all submodules to the latest
```bash
magoo update
```
- Update one submodule to the latest
```bash
magoo update NAME
```
- Change the branch and/or URL of a submodule
```bash
magoo update NAME --branch BRANCH --url URL
```
### Remove submodules
```bash
magoo remove NAME [--force]
```
`--force` will discard any changes made in the submodule (`git submodule deinit --force`)
Note: Newer versions of git lets you delete a submodule with `git rm`. However, it doesn't delete the content in
`.git/modules`.  deletes those.
