Skip to content

Commit f712146

Browse files
Update documentation for git-repl
1 parent 95ccb62 commit f712146

File tree

4 files changed

+56
-65
lines changed

4 files changed

+56
-65
lines changed

Commands.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -382,10 +382,9 @@ the repl.
382382

383383
```bash
384384
$ git repl
385-
git version 2.9.2
386-
git-extras version 3.0.0
387-
type 'ls' to ls files below current directory,
388-
'!command' to execute any command or just 'subcommand' to execute any git subcommand
385+
git version 2.34.1
386+
git-extras version 7.3.0
387+
Type 'ls' to ls files below current directory; '!command' to execute any command or just 'subcommand' to execute any git subcommand; 'quit', 'exit', 'q', ^D, or ^C to exit the git repl.
389388

390389
git (master)> ls-files
391390
History.md

man/git-repl.1

Lines changed: 16 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,42 @@
1-
.\" generated with Ronn/v0.7.3
2-
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3-
.
4-
.TH "GIT\-REPL" "1" "October 2017" "" "Git Extras"
5-
.
1+
.\" generated with Ronn-NG/v0.9.1
2+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3+
.TH "GIT\-REPL" "1" "September 2024" "" "Git Extras"
64
.SH "NAME"
75
\fBgit\-repl\fR \- git read\-eval\-print\-loop
8-
.
96
.SH "SYNOPSIS"
107
\fBgit\-repl\fR
11-
.
8+
.P
9+
\fBgit\-repl\fR [command\|\.\|\.\|\.]
1210
.SH "DESCRIPTION"
13-
Git read\-eval\-print\-loop\. Lets you run \fBgit\fR commands without typing \'git\'\.
14-
.
11+
Git read\-eval\-print\-loop\. Lets you run \fBgit\fR commands without typing 'git'\.
12+
.P
13+
Commands can be prefixed with an exclamation mark (!) to be interpreted as a regular shell command\.
1514
.P
16-
Commands can be prefixed with an exclamation mark (!) to be interpreted as a regular command\.
17-
.
15+
Any arguments to git repl will be taken collectively as the first command to execute in the repl\.
1816
.P
19-
Type \fBexit\fR or \fBquit\fR to end the repl session\.
20-
.
17+
Type \fBexit\fR, \fBquit\fR, or \fBq\fR to end the repl session\. Ctrl\-D an Ctrl\-C will also work\.
2118
.SH "COMMANDS"
2219
<command>
23-
.
2420
.P
2521
Interpreted as \fBgit <command>\fR\.
26-
.
2722
.P
2823
!<command>
29-
.
3024
.P
3125
Interpreted as \fB<command>\fR (not through \fBgit\fR)\.
32-
.
3326
.P
3427
ls
35-
.
3628
.P
37-
Equivalent of \'git ls\-files\'\.
38-
.
29+
Equivalent of 'git ls\-files'\.
3930
.P
40-
exit|quit
41-
.
31+
exit|quit|q
4232
.P
4333
Ends the repl session\.
44-
.
4534
.SH "EXAMPLES"
46-
.
4735
.nf
48-
4936
$ git repl
50-
git version 2\.9\.2
51-
git\-extras version 3\.0\.0
52-
type \'ls\' to ls files below current directory,
53-
\'!command\' to execute any command or just \'subcommand\' to execute any git subcommand
37+
git version 2\.34\.1
38+
git\-extras version 7\.3\.0
39+
Type 'ls' to ls files below current directory; '!command' to execute any command or just 'subcommand' to execute any git subcommand; 'quit', 'exit', 'q', ^D, or ^C to exit the git repl\.
5440

5541
git (master)> ls\-files
5642
History\.md
@@ -67,14 +53,10 @@ git (master)> !echo Straight from the shell!
6753
Straight from the shell!
6854

6955
git (master)> quit
70-
.
7156
.fi
72-
.
7357
.SH "AUTHOR"
74-
Written by Tj Holowaychuk <\fItj@vision\-media\.ca\fR>
75-
.
58+
Written by Tj Holowaychuk <\fItj@vision\-media\.ca\fR>\. Updated by Wyatt S Carpenter to add display of the previous command's exit status, 'q', and the ability to pass in the initial command as arguments\.
7659
.SH "REPORTING BUGS"
7760
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
78-
.
7961
.SH "SEE ALSO"
8062
<\fIhttps://github\.com/tj/git\-extras\fR>

man/git-repl.html

Lines changed: 28 additions & 23 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/git-repl.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,17 @@ git-repl(1) -- git read-eval-print-loop
55

66
`git-repl`
77

8+
`git-repl` [command...]
9+
810
## DESCRIPTION
911

1012
Git read-eval-print-loop. Lets you run `git` commands without typing 'git'.
1113

1214
Commands can be prefixed with an exclamation mark (!) to be interpreted as
13-
a regular command.
15+
a regular shell command.
16+
17+
Any arguments to git repl will be taken collectively as the first command
18+
to execute in the repl.
1419

1520
Type `exit`, `quit`, or `q` to end the repl session. Ctrl-D an Ctrl-C
1621
will also work.
@@ -29,7 +34,7 @@ git-repl(1) -- git read-eval-print-loop
2934

3035
Equivalent of 'git ls-files'.
3136

32-
exit|quit|q
37+
exit\|quit\|q
3338

3439
Ends the repl session.
3540

@@ -39,7 +44,7 @@ git-repl(1) -- git read-eval-print-loop
3944
$ git repl
4045
git version 2.34.1
4146
git-extras version 7.3.0
42-
type 'ls' to ls files below current directory, '!command' to execute any command or just 'subcommand' to execute any git subcommand. 'quit', 'exit', 'q', ^D, or ^C to exit the git repl.
47+
Type 'ls' to ls files below current directory; '!command' to execute any command or just 'subcommand' to execute any git subcommand; 'quit', 'exit', 'q', ^D, or ^C to exit the git repl.
4348

4449
git (master)> ls-files
4550
History.md
@@ -59,7 +64,7 @@ git-repl(1) -- git read-eval-print-loop
5964

6065
## AUTHOR
6166

62-
Written by Tj Holowaychuk &lt;<[email protected]>&gt;
67+
Written by Tj Holowaychuk &lt;<[email protected]>&gt;. Updated by Wyatt S Carpenter to add display of the previous command's exit status, 'q', and the ability to pass in the initial command as arguments.
6368

6469
## REPORTING BUGS
6570

0 commit comments

Comments
 (0)