Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eeue56/twp
A simpler interface to git
https://github.com/eeue56/twp
Last synced: about 2 months ago
JSON representation
A simpler interface to git
- Host: GitHub
- URL: https://github.com/eeue56/twp
- Owner: eeue56
- License: bsd-3-clause
- Created: 2024-05-11T03:37:44.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-11T03:37:45.000Z (9 months ago)
- Last Synced: 2024-05-21T12:33:42.584Z (8 months ago)
- Size: 1000 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# twp
A simpler interface to git
## Principles
- `git` has many features but a broad UX
- `git` shouldn't be replaced, but the UX should be
- Interactively using `git` leads to better usage
- Common commands should be short, ideally 4 characters.
- Less common commands should have memorable names.
- Naming things differently from git helps separate the usage between `git` and `twp`.
- Developer-first: scripts should use `git` instead.
## Start a repo
Purpose: Clone a repo locally.
Replaces: `git clone`, `git init`
Principle: Most repos will be started remotely, then cloned to each developer machine.
```
twp init [email protected]:eeue56/twp.git
```
## Save your work
Purpose: Add your work to the repo.
Replaces: `git add`, `git commit`
Principle: Interactively selecting content to save, and the message, leads to cleaner history.
```
twp save
```
## Edit what your last save included
Purpose: Add or remove work from your last saved work.
Replaces: `git add -p --amend`, `git commit -p --amend`
Principle: Easier editing of commits leads to cleaner commits.
```
twp edit
```
## Send your work
Purpose: Send your saved work to the repo.
Replaces: `git push`
Principle: Sending saved work should only apply to your current branch. The branch should have the same name on the server.
```
twp send
```
## Recieve (recv) work
Purpose: Get work from the repo.
Replaces: `git pull`
Principle: Receiving work should only apply to your current branch.
```
twp recv
```
## See info about a repo
Purpose: See relevant info about a repo.
Replaces: `git status`, `git remote`
Principle: Knowing the remote is important to separate public work from private. Knowing what the differences locally vs remotely is useful for workflow.
```
twp info
```
## Swap which active branch you are working on
Purpose: Swap active branch.
Replaces: `git checkout`, `git switch`
Principle: Interactively swapping is easier than remembering the branch name.
```
twp swap
```
## Store a copy of your work, but undo the changes made
Purpose: Keeping some changes for later without currently saving them.
Replaces: `git stash push`
Principle: Interactively selecting changes to store, with a message, makes storing more useful.
```
twp quick-save
```
## Load a copy of your work
Purpose: Keeping some changes for later without currently saving them.
Replaces: `git stash pop`
Principle: Interactively selecting changes to store, with a message, makes storing more useful.
```
twp quick-load
```
## Drop
Purpose: Set everything back to the last saved version
Replace: `git reset`, `git checkout`
Principle: Interactively resetting changes simplifies reset.
```
twp drop
```