Skip to content

Commit 13bdd23

Browse files
kltdwrdsclaude
andcommitted
docs: add shell aliases & functions section to README
Document the Git aliases and shell functions included via dotfiles to help new team members discover these productivity shortcuts. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent a459d28 commit 13bdd23

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,26 @@ Packages (installed with Homebrew):
161161

162162
My [dotfiles](https://github.com/geerlingguy/dotfiles) are also installed into the current user's home directory, including the `.osx` dotfile for configuring many aspects of macOS for better performance and ease of use. You can disable dotfiles management by setting `configure_dotfiles: no` in your configuration.
163163

164+
### Shell Aliases & Functions
165+
166+
The dotfiles include helpful Git aliases and shell functions:
167+
168+
| Alias | Command |
169+
|-------|---------|
170+
| `gs` | `git status` |
171+
| `gc` | `git commit` |
172+
| `gp` | `git pull --rebase` |
173+
| `gcam` | `git commit -am` |
174+
| `gl` | `git log --graph --pretty=format:...` (formatted log) |
175+
| `gm` | `git mogged` ;) |
176+
177+
| Function | Purpose |
178+
|----------|---------|
179+
| `gsync` | Synchronize a Git branch with upstream |
180+
| `dockrun` | Run Docker containers with Ansible |
181+
| `denter` | Enter a running Docker container |
182+
| `knownrm` | Remove a line from SSH known_hosts file |
183+
164184
Finally, there are a few other preferences and settings added on for various apps and services.
165185

166186
## Full / From-scratch setup guide

0 commit comments

Comments
 (0)