git-rewrite 0.1.0

Filter and rewrite history, trees, and (eventuall) blobs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

# ✏️ `git-rewrite`

*Porcelain for rewriting repository history, trees, and (eventually) blobs.*

<!-- rumdl-disable MD013 -->
[![CI](https://github.com/git-ents/git-filter/actions/workflows/CI.yml/badge.svg)](https://github.com/git-ents/git-filter/actions/workflows/CI.yml)
[![CD](https://github.com/git-ents/git-filter/actions/workflows/CD.yml/badge.svg)](https://github.com/git-ents/git-filter/actions/workflows/CD.yml)
<!-- rumdl-enable MD013 -->

> [!CAUTION]
> This project is being actively developed!
> Despite this, semantic versioning rules will be respected.
> Expect frequent updates.

## Motivation

To support a more expansive usage of the Git object database, as is the goal for other projects within the [`git-ents`](https://github.com/git-ents) organization, new porecelain is needed.
This project provides porcelain that allows users to rewrite repository history as safely as possible.

## Installation

### CLI

The `git-rewrite` porecelain command can be installed with `cargo install`.

```shell
cargo install --locked git-rewrite
```

To install the latest development version, install from Git.

```shell
cargo install --git https://github.com/git-ents/git-rewrite
```

If `~/.cargo/bin` is on your `PATH`, you can invoke the command with `git`.

```shell
git rewrite -h
```