Skip to content

Commit f118632

Browse files
authored
Update README.md
1 parent 178f7f0 commit f118632

File tree

1 file changed

+41
-6
lines changed

1 file changed

+41
-6
lines changed

README.md

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,49 @@ This is an extension to enable management of git submodules with the [github cli
1616
3. Your good to go..`gh subrepo -h`
1717

1818
### Commands
19+
```
20+
Commands:
21+
clone Clone a remote repository into a local subdirectory
22+
init Turn a current subdirectory into a subrepo
23+
pull Pull upstream changes to the subrepo
24+
push Push local subrepo changes upstream
1925
20-
- **clone**: `gh subrepo clone {repo_url.git} {path}`
21-
- **pull**: `gh subrepo pull {path}`
22-
- **push**: `gh subrepo push {path}`
23-
- **fetch**: `gh subrepo fetch {path}`
24-
- **status**: `gh subrepo status {path}`
25-
- **branch**: `gh subrepo branch {path}`
26+
fetch Fetch a subrepo's remote branch (and create a ref for it)
27+
branch Create a branch containing the local subrepo commits
28+
commit Commit a merged subrepo branch into the mainline
2629
30+
status Get status of a subrepo (or all of them)
31+
clean Remove branches, remotes and refs for a subrepo
32+
config Set subrepo configuration properties
33+
34+
help Documentation for git-subrepo (or specific command)
35+
version Display git-subrepo version info
36+
upgrade Upgrade the git-subrepo software itself
37+
```
38+
39+
### Options
40+
```
41+
Show the command summary
42+
--[no-]help Help overview
43+
--[no-]version Print the git-subrepo version number
44+
-a, --[no-]all Perform command on all current subrepos
45+
-A, --[no-]ALL Perform command on all subrepos and subsubrepos
46+
-b, --[no-]branch ... Specify the upstream branch to push/pull/fetch
47+
-e, --[no-]edit Edit commit message
48+
-f, --[no-]force Force certain operations
49+
-F, --[no-]fetch Fetch the upstream content first
50+
-M, --[no-]method ... Join method: 'merge' (default) or 'rebase'
51+
-m, --[no-]message ...
52+
Specify a commit message
53+
--[no-]file ... Specify a commit message file
54+
-r, --[no-]remote ... Specify the upstream remote to push/pull/fetch
55+
-s, --[no-]squash Squash commits on push
56+
-u, --[no-]update Add the --branch and/or --remote overrides to .gitrepo
57+
-q, --[no-]quiet Show minimal output
58+
-v, --[no-]verbose Show verbose output
59+
-d, --[no-]debug Show the actual commands used
60+
-x, --[no-]DEBUG Turn on -x Bash debugging
61+
```
2762
### Inspiration
2863

2964
⭐ Inspired by [git-subrepo](https://github.com/ingydotnet/git-subrepo)

0 commit comments

Comments
 (0)