https://github.com/captainsafia/giddy
A CLI wrapper around git for an improved developer experience
https://github.com/captainsafia/giddy
Last synced: 8 months ago
JSON representation
A CLI wrapper around git for an improved developer experience
- Host: GitHub
- URL: https://github.com/captainsafia/giddy
- Owner: captainsafia
- License: mit
- Created: 2017-05-01T02:43:49.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-21T00:39:32.000Z (over 8 years ago)
- Last Synced: 2025-04-15T01:44:19.465Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 147
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-github-repos - captainsafia/giddy - A CLI wrapper around git for an improved developer experience (JavaScript)
README
# giddy
giddy is a command line tool designed to help you manage your git workflow.
It addresses some of the gaps that I've found in git's user experience and
provides some helpful aliases for dealing with common git pitfalls. If you've
experienced any pitfalls or user experience hiccups with git that you think
should be addressed in giddy, please submit an issue.
If you think giddy is totally rad, you should
[give Safia some money](https://www.paypal.me/captainsafia).
## Installation
```
npm install --global giddy
```
## Usage
### Stage and Undo
The `git add` and `git rm` commands can be a little opaque to new git users. In
order to more transparently communicate what they do, `giddy stage ` runs
either `git rm ` or `git add ` for a given file depending on whether
or not it has been removed from the project.
`giddy undo ` undoes unstaged changes to a file by checking out the
version of the file associated with the most recent commit. `git undo --all`
undoes unstaged changes to all files in the project.
### Revision History Traversal
Sometimes it's helpful to browse through changes in a project commit
by commit. giddy provides a few simple commands for traversing the
revision history for a particular project.
`giddy back` goes backwards one commit in the revision history. For example,
in order to go back three commits into the project, a user can input the following
commands.
```
$ giddy back
$ giddy back
$ giddy back
```
`giddy forward` goes forward one commit in the revision history until the user
has hit the most recent commit for a project. For example, to navigate back
two commits and forward one, a use can input the following commands.
```
$ giddy back
$ giddy back
$ giddy forward
```
These actions will happen in detached HEAD mode.
`giddy latest` takes the user to the most recent commit in the revision
history regardless of where they are.
### giddy-oops
The giddy-oops command is designed to provide shortcuts to handle common git pitfalls
like accidently committing a sensitive file to the repository, forgetting to stage a
file onto a commit, or undoing the most recent commit.
In order to undo a commit of a sensitive file and remove all references to that file
from the revision history, the user can run the following command.
```
giddy-oops no-git super-secret-file.env
```
In order to stage a file onto an existing commit, you can run the following command.
```
giddy-oops missed i-totally-forgot-to-stage-this.txt
```
Happy gittin'!