Skip to content

Commit 99db3f7

Browse files
committed
Add a README
1 parent b9f1ad3 commit 99db3f7

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# git-get
2+
3+
git-get is an opinionated git command that helps you keep your code folder in order.
4+
5+
git-get is a simple wrapper for `git clone` that clones your repository into a standard location so that you always know where your code is.
6+
7+
git-get will place you inside your new folder when you're done because it saves typing `cd <the thing you just typed already>` :)
8+
9+
## Installing
10+
11+
All you get to do is to put `git-get` somewhere in your path :)
12+
13+
## Examples
14+
15+
```shell
16+
git get https://github.com/stilvoid/git-get
17+
Cloning into '/home/steve/code/github.com/stilvoid/git-get'...
18+
```
19+
20+
git-get uses the repository URL to figure out where to place your checked out copy.
21+
22+
By default, git-get places all repositories under `~/code` but you can change that by setting get.location:
23+
24+
```shell
25+
git config --global get.location ~/projects
26+
```

0 commit comments

Comments
 (0)