Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ skills-lock.json
# already existing elements were commented out

#/target
*.mp4
.mimocode/
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 Jheison Morales

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,11 @@ gitkit attributes init
gitkit config apply defaults
```

## Documentation

Full documentation lives in [`docs/`](docs/): installation, quick start,
hooks, ignore & attributes, config presets, builds and the complete CLI reference.

---

## `gitkit status`
Expand Down Expand Up @@ -316,4 +321,5 @@ MIT

---

Made with ❤️ by [JheisonMB](https://github.com/JheisonMB) and [UniverLab](https://github.com/UniverLab)
An experiment of [UniverLab](https://github.com/UniverLab) — an open computational laboratory.
Made with ❤️ by [JheisonMB](https://github.com/JheisonMB)
Binary file modified assets/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
339 changes: 339 additions & 0 deletions demo/demo.rec

Large diffs are not rendered by default.

224 changes: 224 additions & 0 deletions demo/demo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
[demo]
name = "demo"
output_dir = "./dist"
prompt = '\[\e[1;32m\]gitkit@univerlab\[\e[0m\]:\[\e[1;34m\]~\[\e[0m\]$ '

[typing]
base_ms = 80
salt_ms = 15

[layout]
width = 1440
height = 1080
fps = 15
line_height = 1.2000000476837158
background = "#0b0f14"
font_family = "IBM Plex Mono"

[[layout.panes]]
id = "main"
type = "terminal"
x = 0
y = 0
width = 1440
height = 1080
font_family = "monospace"
font_size = 16

[[timeline]]
action = "focus"
pane = "main"

[[timeline]]
action = "type"
text = "gitkit clone https://github.com/Univerlab/gitkit.git"
human_salt = true

[[timeline]]
action = "wait"
duration_ms = 200

[[timeline]]
action = "keypress"
key = "enter"

[[timeline]]
action = "wait"
duration_ms = 200

[[timeline]]
action = "keypress"
key = "enter"

[[timeline]]
action = "wait_for_quiet"
quiet_ms = 1500

[[timeline]]
action = "keypress"
key = "down"

[[timeline]]
action = "wait"
duration_ms = 349

[[timeline]]
action = "keypress"
key = "down"

[[timeline]]
action = "wait"
duration_ms = 1316

[[timeline]]
action = "type"
text = " "
human_salt = true

[[timeline]]
action = "wait"
duration_ms = 2295

[[timeline]]
action = "keypress"
key = "down"

[[timeline]]
action = "wait"
duration_ms = 2500

[[timeline]]
action = "type"
text = " "
human_salt = true

[[timeline]]
action = "wait"
duration_ms = 200

[[timeline]]
action = "keypress"
key = "enter"

[[timeline]]
action = "wait_for_quiet"
quiet_ms = 500

[[timeline]]
action = "type"
text = " "
human_salt = true

[[timeline]]
action = "wait"
duration_ms = 200

[[timeline]]
action = "keypress"
key = "enter"

[[timeline]]
action = "wait"
duration_ms = 200

[[timeline]]
action = "keypress"
key = "enter"

[[timeline]]
action = "wait_for_quiet"
quiet_ms = 1500

[[timeline]]
action = "keypress"
key = "down"

[[timeline]]
action = "wait"
duration_ms = 180

[[timeline]]
action = "keypress"
key = "down"

[[timeline]]
action = "wait"
duration_ms = 180

[[timeline]]
action = "keypress"
key = "down"

[[timeline]]
action = "wait"
duration_ms = 174

[[timeline]]
action = "keypress"
key = "down"

[[timeline]]
action = "wait"
duration_ms = 183

[[timeline]]
action = "keypress"
key = "down"

[[timeline]]
action = "wait"
duration_ms = 452

[[timeline]]
action = "type"
text = " "
human_salt = true

[[timeline]]
action = "wait"
duration_ms = 200

[[timeline]]
action = "keypress"
key = "enter"

[[timeline]]
action = "wait_for_quiet"
quiet_ms = 1500

[[timeline]]
action = "type"
text = "y"
human_salt = true

[[timeline]]
action = "wait"
duration_ms = 200

[[timeline]]
action = "keypress"
key = "enter"

[[timeline]]
action = "wait_for_quiet"
quiet_ms = 1500

[[timeline]]
action = "type"
text = "n"
human_salt = true

[[timeline]]
action = "wait"
duration_ms = 200

[[timeline]]
action = "keypress"
key = "enter"

[[timeline]]
action = "wait_for_quiet"
quiet_ms = 1500

[[timeline]]
action = "terminate"
Binary file added demo/dist/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo/dist/demo.mp4
Binary file not shown.
37 changes: 37 additions & 0 deletions docs/builds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Builds
description: Save a repo configuration once and re-apply it to any project.
order: 7
---

# Builds

A **build** is a saved snapshot of a repository's gitkit configuration —
hooks, ignore templates, attributes and config presets — stored as a TOML
file under `~/.gitkit/builds/`.

Builds turn your preferred setup into a one-liner for every future
project.

## Workflow

```bash
# Configure a repo the way you like, then save it
gitkit build save rust-dev --description "Rust development setup"

# Apply it to any other project
cd /path/to/other/project
gitkit build apply rust-dev
```

## Managing builds

```bash
gitkit build list # list saved builds
gitkit build save <name> # save current repo config as a build
gitkit build apply <name> # apply a saved build
gitkit build delete <name> # delete a saved build
```

Because builds are plain TOML files, you can version them in your dotfiles
and share them across machines.
77 changes: 77 additions & 0 deletions docs/cli-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: CLI Reference
description: Every gitkit command and flag.
order: 8
---

# CLI Reference

```
gitkit [command] [options]
```

Running `gitkit` with no command starts the interactive wizard.

## Core

| Command | Description |
|---|---|
| `gitkit` / `gitkit init` | Interactive wizard to configure the repo |
| `gitkit status` | Show current configuration status |
| `gitkit clone <repo> [dir]` | Clone a repository and run the wizard |
| `gitkit clone -b <branch> <repo>` | Clone a specific branch |

## Hooks

| Command | Description |
|---|---|
| `gitkit hooks add <builtin>` | Install a built-in hook (hook type inferred) |
| `gitkit hooks add <hook> <command>` | Install a custom shell command as a hook |
| `gitkit hooks list` | List installed hooks |
| `gitkit hooks list --available` | Show all built-in hooks with descriptions |
| `gitkit hooks remove <hook>` | Remove an installed hook |
| `gitkit hooks show <hook>` | Print hook content |

## Ignore

| Command | Description |
|---|---|
| `gitkit ignore add <templates>` | Generate/merge `.gitignore` via gitignore.io |
| `gitkit ignore list [filter]` | List available templates |

## Attributes

| Command | Description |
|---|---|
| `gitkit attributes init` | Apply line-endings preset to `.gitattributes` |

## Config

| Command | Description |
|---|---|
| `gitkit config apply defaults` | `push.autoSetupRemote`, `help.autocorrect`, `diff.algorithm` |
| `gitkit config apply advanced` | `merge.conflictstyle zdiff3`, `rerere.enabled` |
| `gitkit config apply delta` | `core.pager delta` |
| `gitkit config show` | Show current git config values |

Scope: `--global` (all repos) or `--local` (current repo). Default is
`--local` inside a repo, `--global` otherwise.

## Builds

| Command | Description |
|---|---|
| `gitkit build list` | List saved builds |
| `gitkit build save <name>` | Save current repo config as a build |
| `gitkit build apply <name>` | Apply a saved build |
| `gitkit build delete <name>` | Delete a saved build |

## Global flags

| Flag | Description |
|---|---|
| `--yes`, `-y` | Skip confirmation prompts |
| `--force`, `-f` | Overwrite existing files |
| `--dry-run` | Preview changes without applying |
| `--help` | Show help for any command |
| `--version` | Show gitkit version |
Loading
Loading