Skip to content

Commit 3e3b663

Browse files
committed
docs: document gitkit clone command and update quick start section
1 parent db3af3b commit 3e3b663

1 file changed

Lines changed: 47 additions & 2 deletions

File tree

README.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,13 @@ Remove-Item "$env:LOCALAPPDATA\gitkit\gitkit.exe" -Force
6565

6666
## Quick Start
6767

68-
Interactive wizard — guided setup for a new repo:
68+
**Clone and configure a repo in one command:**
69+
70+
```bash
71+
gitkit clone https://github.com/user/repo
72+
```
73+
74+
Or configure an existing repo:
6975

7076
```bash
7177
gitkit init
@@ -91,12 +97,51 @@ Interactive wizard that guides you through configuring a repo step by step.
9197
- `.gitattributes` — line endings and binary file presets
9298
- Git config — 6 individual options, recommended ones pre-selected
9399

94-
```
100+
Automatically initializes a git repository if one doesn't exist:
101+
102+
```bash
95103
gitkit init
96104
```
97105

98106
---
99107

108+
## `gitkit clone`
109+
110+
Clone a repository and automatically run `gitkit init` to configure it.
111+
112+
**Usage:**
113+
114+
```bash
115+
gitkit clone [OPTIONS] <REPOSITORY> [DIRECTORY]
116+
```
117+
118+
**Arguments:**
119+
120+
- `<REPOSITORY>` — Repository URL or path to clone
121+
- `[DIRECTORY]` — Target directory (defaults to repository name)
122+
123+
**Options:**
124+
125+
- `-b, --branch <BRANCH>` — Clone specific branch (defaults to repository default)
126+
- `-h, --help` — Print help
127+
128+
**Examples:**
129+
130+
```bash
131+
# Clone and auto-configure
132+
gitkit clone https://github.com/user/repo
133+
134+
# Clone specific branch
135+
gitkit clone -b develop https://github.com/user/repo
136+
137+
# Clone to custom directory
138+
gitkit clone https://github.com/user/repo my-project
139+
```
140+
141+
The wizard runs automatically after cloning, allowing you to configure hooks, `.gitignore`, `.gitattributes`, and git config in one workflow.
142+
143+
---
144+
100145
## Commands
101146

102147
### Hooks

0 commit comments

Comments
 (0)