submodule-kit 0.2.0

A CLI toolkit for managing git submodules
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# Command-Line Help for `submodule-kit`

This document contains the help content for the `submodule-kit` command-line program.

**Command Overview:**

* [`submodule-kit`↴](#submodule-kit)
* [`submodule-kit list`↴](#submodule-kit-list)
* [`submodule-kit is`↴](#submodule-kit-is)

## `submodule-kit`

A CLI toolkit for managing git submodules

**Usage:** `submodule-kit <COMMAND>`

###### **Subcommands:**

* `list` — List all submodules
* `is` — Check one or more conditions about submodules; exits 0 (all true) or 1 (any false)



## `submodule-kit list`

List all submodules

**Usage:** `submodule-kit list`



## `submodule-kit is`

Check one or more conditions about submodules; exits 0 (all true) or 1 (any false)

**Usage:** `submodule-kit is [CONDITIONS]...`

###### **Arguments:**

* `<CONDITIONS>`

  Possible values:
  - `all-up-to-date`:
    Check whether every submodule's parent-recorded commit matches the tip of its remote branch
  - `populated`:
    Check whether all submodules have been initialized and cloned locally
  - `clean`:
    Check whether all submodules have no uncommitted changes
  - `synced`:
    Check whether each submodule's locally checked-out commit matches what the parent records
  - `on-branch`:
    Check whether all submodules are checked out on their configured branch (not detached HEAD)




<hr/>

<small><i>
    This document was generated automatically by
    <a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>.
</i></small>

## License

MIT — see [LICENSE](LICENSE)