Skip to content

Commit 4ca3126

Browse files
Update readme to add documentation for rm, mv, and clean
Signed-off-by: Jacob Stopak <jacob@initialcommit.io>
1 parent 8cbb5f9 commit 4ca3126

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Example: `$ git-sim merge <branch>`
2626

2727
## Features
2828
- Run a one-liner git-sim command in the terminal to generate a custom Git command visualization (.jpg) from your repo
29-
- Supported commands: `log`, `status`, `add`, `restore`, `commit`, `stash`, `branch`, `tag`, `reset`, `revert`, `merge`, `rebase`, `cherry-pick`, `switch`, `checkout`, `fetch`, `pull`, `push`, `clone`
29+
- Supported commands: `log`, `status`, `add`, `restore`, `commit`, `stash`, `branch`, `tag`, `reset`, `revert`, `merge`, `rebase`, `cherry-pick`, `switch`, `checkout`, `fetch`, `pull`, `push`, `clone`, `rm`, `mv`, `clean`
3030
- Generate an animated video (.mp4) instead of a static image using the `--animate` flag (note: significant performance slowdown, it is recommended to use `--low-quality` to speed up testing and remove when ready to generate presentation-quality video)
3131
- Color commits by parameter, such as author the `--color-by=author` option
3232
- Choose between dark mode (default) and light mode
@@ -126,7 +126,7 @@ $ git-sim <subcommand> -h
126126
* [Manim (Community version)](https://www.manim.community/)
127127

128128
## Commands
129-
Basic usage is similar to Git itself - `git-sim` takes a familiar set of subcommands including "log", "status", "add", "restore", "commit", "stash", "branch", "tag", "reset", "revert", "merge", "rebase", "cherry-pick", "switch", "checkout", "fetch", "pull", "push", "clone", along with corresponding options.
129+
Basic usage is similar to Git itself - `git-sim` takes a familiar set of subcommands including "log", "status", "add", "restore", "commit", "stash", "branch", "tag", "reset", "revert", "merge", "rebase", "cherry-pick", "switch", "checkout", "fetch", "pull", "push", "clone", "rm", "mv", "clean" along with corresponding options.
130130

131131
```console
132132
$ git-sim [global options] <subcommand> [subcommand options]
@@ -320,6 +320,28 @@ Usage: `git-sim clone <url>`
320320
- Clone the remote repo from `<url>` (web URL or filesystem path) to a new folder in the current directory
321321
- Output will report if clone operation is successful and show log of local clone
322322

323+
### git rm
324+
Usage: `git-sim rm <file 1> <file 2> ... <file n>`
325+
326+
- Specify one or more `<file>` as a *tracked* file
327+
- Simulated output will show files being removed from Git tracking
328+
- Note that simulated output will also show the most recent 5 commits on the active branch
329+
330+
### git mv
331+
Usage: `git-sim mv <file> <new file>`
332+
333+
- Specify `<file>` as file to update name/path
334+
- Specify `<new file>` as new name/path of file
335+
- Simulated output will show the name/path of the file being updated
336+
- Note that simulated output will also show the most recent 5 commits on the active branch
337+
338+
### git clean
339+
Usage: `git-sim clean`
340+
341+
- Simulated output will show untracked files being deleted
342+
- Since this is just a simulation, no need to specify `-i`, `-n`, `-f` as in regular Git
343+
- Note that simulated output will also show the most recent 5 commits on the active branch
344+
323345
## Video animation examples
324346
```console
325347
$ git-sim --animate reset HEAD^

0 commit comments

Comments
 (0)