Skip to content

Commit e7e6d83

Browse files
JheisonMBJheisonMB
authored
Merge pull request #13 from UniverLab/docs/initial-docs
docs: initial docs, SHA256 checksums, demo artifacts
2 parents c33d06d + b43df86 commit e7e6d83

20 files changed

Lines changed: 1106 additions & 52 deletions

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ skills-lock.json
1818
# already existing elements were commented out
1919

2020
#/target
21+
*.mp4
22+
.mimocode/

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Jheison Morales
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,11 @@ gitkit attributes init
113113
gitkit config apply defaults
114114
```
115115

116+
## Documentation
117+
118+
Full documentation lives in [`docs/`](docs/): installation, quick start,
119+
hooks, ignore & attributes, config presets, builds and the complete CLI reference.
120+
116121
---
117122

118123
## `gitkit status`
@@ -316,4 +321,5 @@ MIT
316321

317322
---
318323

319-
Made with ❤️ by [JheisonMB](https://github.com/JheisonMB) and [UniverLab](https://github.com/UniverLab)
324+
An experiment of [UniverLab](https://github.com/UniverLab) — an open computational laboratory.
325+
Made with ❤️ by [JheisonMB](https://github.com/JheisonMB)

‎assets/demo.gif‎

41.3 KB
Loading

‎demo/demo.rec‎

Lines changed: 339 additions & 0 deletions
Large diffs are not rendered by default.

‎demo/demo.toml‎

Lines changed: 224 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
1+
[demo]
2+
name = "demo"
3+
output_dir = "./dist"
4+
prompt = '\[\e[1;32m\]gitkit@univerlab\[\e[0m\]:\[\e[1;34m\]~\[\e[0m\]$ '
5+
6+
[typing]
7+
base_ms = 80
8+
salt_ms = 15
9+
10+
[layout]
11+
width = 1440
12+
height = 1080
13+
fps = 15
14+
line_height = 1.2000000476837158
15+
background = "#0b0f14"
16+
font_family = "IBM Plex Mono"
17+
18+
[[layout.panes]]
19+
id = "main"
20+
type = "terminal"
21+
x = 0
22+
y = 0
23+
width = 1440
24+
height = 1080
25+
font_family = "monospace"
26+
font_size = 16
27+
28+
[[timeline]]
29+
action = "focus"
30+
pane = "main"
31+
32+
[[timeline]]
33+
action = "type"
34+
text = "gitkit clone https://github.com/Univerlab/gitkit.git"
35+
human_salt = true
36+
37+
[[timeline]]
38+
action = "wait"
39+
duration_ms = 200
40+
41+
[[timeline]]
42+
action = "keypress"
43+
key = "enter"
44+
45+
[[timeline]]
46+
action = "wait"
47+
duration_ms = 200
48+
49+
[[timeline]]
50+
action = "keypress"
51+
key = "enter"
52+
53+
[[timeline]]
54+
action = "wait_for_quiet"
55+
quiet_ms = 1500
56+
57+
[[timeline]]
58+
action = "keypress"
59+
key = "down"
60+
61+
[[timeline]]
62+
action = "wait"
63+
duration_ms = 349
64+
65+
[[timeline]]
66+
action = "keypress"
67+
key = "down"
68+
69+
[[timeline]]
70+
action = "wait"
71+
duration_ms = 1316
72+
73+
[[timeline]]
74+
action = "type"
75+
text = " "
76+
human_salt = true
77+
78+
[[timeline]]
79+
action = "wait"
80+
duration_ms = 2295
81+
82+
[[timeline]]
83+
action = "keypress"
84+
key = "down"
85+
86+
[[timeline]]
87+
action = "wait"
88+
duration_ms = 2500
89+
90+
[[timeline]]
91+
action = "type"
92+
text = " "
93+
human_salt = true
94+
95+
[[timeline]]
96+
action = "wait"
97+
duration_ms = 200
98+
99+
[[timeline]]
100+
action = "keypress"
101+
key = "enter"
102+
103+
[[timeline]]
104+
action = "wait_for_quiet"
105+
quiet_ms = 500
106+
107+
[[timeline]]
108+
action = "type"
109+
text = " "
110+
human_salt = true
111+
112+
[[timeline]]
113+
action = "wait"
114+
duration_ms = 200
115+
116+
[[timeline]]
117+
action = "keypress"
118+
key = "enter"
119+
120+
[[timeline]]
121+
action = "wait"
122+
duration_ms = 200
123+
124+
[[timeline]]
125+
action = "keypress"
126+
key = "enter"
127+
128+
[[timeline]]
129+
action = "wait_for_quiet"
130+
quiet_ms = 1500
131+
132+
[[timeline]]
133+
action = "keypress"
134+
key = "down"
135+
136+
[[timeline]]
137+
action = "wait"
138+
duration_ms = 180
139+
140+
[[timeline]]
141+
action = "keypress"
142+
key = "down"
143+
144+
[[timeline]]
145+
action = "wait"
146+
duration_ms = 180
147+
148+
[[timeline]]
149+
action = "keypress"
150+
key = "down"
151+
152+
[[timeline]]
153+
action = "wait"
154+
duration_ms = 174
155+
156+
[[timeline]]
157+
action = "keypress"
158+
key = "down"
159+
160+
[[timeline]]
161+
action = "wait"
162+
duration_ms = 183
163+
164+
[[timeline]]
165+
action = "keypress"
166+
key = "down"
167+
168+
[[timeline]]
169+
action = "wait"
170+
duration_ms = 452
171+
172+
[[timeline]]
173+
action = "type"
174+
text = " "
175+
human_salt = true
176+
177+
[[timeline]]
178+
action = "wait"
179+
duration_ms = 200
180+
181+
[[timeline]]
182+
action = "keypress"
183+
key = "enter"
184+
185+
[[timeline]]
186+
action = "wait_for_quiet"
187+
quiet_ms = 1500
188+
189+
[[timeline]]
190+
action = "type"
191+
text = "y"
192+
human_salt = true
193+
194+
[[timeline]]
195+
action = "wait"
196+
duration_ms = 200
197+
198+
[[timeline]]
199+
action = "keypress"
200+
key = "enter"
201+
202+
[[timeline]]
203+
action = "wait_for_quiet"
204+
quiet_ms = 1500
205+
206+
[[timeline]]
207+
action = "type"
208+
text = "n"
209+
human_salt = true
210+
211+
[[timeline]]
212+
action = "wait"
213+
duration_ms = 200
214+
215+
[[timeline]]
216+
action = "keypress"
217+
key = "enter"
218+
219+
[[timeline]]
220+
action = "wait_for_quiet"
221+
quiet_ms = 1500
222+
223+
[[timeline]]
224+
action = "terminate"

‎demo/dist/demo.gif‎

253 KB
Loading

‎demo/dist/demo.mp4‎

301 KB
Binary file not shown.

‎docs/builds.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Builds
3+
description: Save a repo configuration once and re-apply it to any project.
4+
order: 7
5+
---
6+
7+
# Builds
8+
9+
A **build** is a saved snapshot of a repository's gitkit configuration —
10+
hooks, ignore templates, attributes and config presets — stored as a TOML
11+
file under `~/.gitkit/builds/`.
12+
13+
Builds turn your preferred setup into a one-liner for every future
14+
project.
15+
16+
## Workflow
17+
18+
```bash
19+
# Configure a repo the way you like, then save it
20+
gitkit build save rust-dev --description "Rust development setup"
21+
22+
# Apply it to any other project
23+
cd /path/to/other/project
24+
gitkit build apply rust-dev
25+
```
26+
27+
## Managing builds
28+
29+
```bash
30+
gitkit build list # list saved builds
31+
gitkit build save <name> # save current repo config as a build
32+
gitkit build apply <name> # apply a saved build
33+
gitkit build delete <name> # delete a saved build
34+
```
35+
36+
Because builds are plain TOML files, you can version them in your dotfiles
37+
and share them across machines.

‎docs/cli-reference.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: CLI Reference
3+
description: Every gitkit command and flag.
4+
order: 8
5+
---
6+
7+
# CLI Reference
8+
9+
```
10+
gitkit [command] [options]
11+
```
12+
13+
Running `gitkit` with no command starts the interactive wizard.
14+
15+
## Core
16+
17+
| Command | Description |
18+
|---|---|
19+
| `gitkit` / `gitkit init` | Interactive wizard to configure the repo |
20+
| `gitkit status` | Show current configuration status |
21+
| `gitkit clone <repo> [dir]` | Clone a repository and run the wizard |
22+
| `gitkit clone -b <branch> <repo>` | Clone a specific branch |
23+
24+
## Hooks
25+
26+
| Command | Description |
27+
|---|---|
28+
| `gitkit hooks add <builtin>` | Install a built-in hook (hook type inferred) |
29+
| `gitkit hooks add <hook> <command>` | Install a custom shell command as a hook |
30+
| `gitkit hooks list` | List installed hooks |
31+
| `gitkit hooks list --available` | Show all built-in hooks with descriptions |
32+
| `gitkit hooks remove <hook>` | Remove an installed hook |
33+
| `gitkit hooks show <hook>` | Print hook content |
34+
35+
## Ignore
36+
37+
| Command | Description |
38+
|---|---|
39+
| `gitkit ignore add <templates>` | Generate/merge `.gitignore` via gitignore.io |
40+
| `gitkit ignore list [filter]` | List available templates |
41+
42+
## Attributes
43+
44+
| Command | Description |
45+
|---|---|
46+
| `gitkit attributes init` | Apply line-endings preset to `.gitattributes` |
47+
48+
## Config
49+
50+
| Command | Description |
51+
|---|---|
52+
| `gitkit config apply defaults` | `push.autoSetupRemote`, `help.autocorrect`, `diff.algorithm` |
53+
| `gitkit config apply advanced` | `merge.conflictstyle zdiff3`, `rerere.enabled` |
54+
| `gitkit config apply delta` | `core.pager delta` |
55+
| `gitkit config show` | Show current git config values |
56+
57+
Scope: `--global` (all repos) or `--local` (current repo). Default is
58+
`--local` inside a repo, `--global` otherwise.
59+
60+
## Builds
61+
62+
| Command | Description |
63+
|---|---|
64+
| `gitkit build list` | List saved builds |
65+
| `gitkit build save <name>` | Save current repo config as a build |
66+
| `gitkit build apply <name>` | Apply a saved build |
67+
| `gitkit build delete <name>` | Delete a saved build |
68+
69+
## Global flags
70+
71+
| Flag | Description |
72+
|---|---|
73+
| `--yes`, `-y` | Skip confirmation prompts |
74+
| `--force`, `-f` | Overwrite existing files |
75+
| `--dry-run` | Preview changes without applying |
76+
| `--help` | Show help for any command |
77+
| `--version` | Show gitkit version |

0 commit comments

Comments
 (0)