<commit_before># Git WebUI

This git extension intends to become your everyday git companion. Run it from
any of your repositories and it will provide you a web based user interface for it.

It comes with history and tree browsing. You may also use this interface to commit
as it comes with a diff review UI and the ability to stage / unstage code.

Moreover as git-webui is also a web server, your repository is accessible to
other people on the same network. They can clone or pull your code using the
same URL.

It has very few dependencies, you probably already have them on your
Mac / Linux : git, python, and a web browser

## Installation

The following command will install git-webui in `$HOME/.git-webui` and add a
`webui` alias to your global `.gitconfig` file

Using curl (Mac OS X):
```
curl https://raw.github.com/alberthier/git-webui/install/installer.sh | bash
```

Using wget (Linux):
```
wget -O - https://raw.github.com/alberthier/git-webui/install/installer.sh | bash
```

Upon installation git-webui will update itself automatically every couple of weeks

## Usage

### Starting

First cd to any of your project versionned with git
```
cd <my-local-git-clone>
git webui
```

This will start an http server and open your default browser with the GUI

### History Viewing

The toolbar on the left shows your branches and tags. The log of the currently selected one is displayed.

When selecting a revision the diff of this specific commit is displayed in the right panel.

On top of the right panel, you can choose 'Tree' to display the versionned content at the specific
revision selected in the left panel. You can browse through directories and display file contents.

![Image of log commit](https://bitbucket.org/alberthier/git-webui/raw/master/doc/img/log-commit.png)
![Image of log tree](https://bitbucket.org/alberthier/git-webui/raw/master/doc/img/log-tree.png)

### Remote access

Other people on your network have read-only access to your repository: they may clone or pull
from your repository through the same url:

Clone:
```
$ git clone http://<ip_of_the_computer_running_webui>:8000/ repo_name
```

Pull:
```
$ git pull http://<ip_of_the_computer_running_webui>:8000/
```

### Commit

Commits can only be made from localhost.

'Working copy' lists the files modified (compared to the staging area) in your working directory

'Staging area' lists the files modified (compared to HEAD) in your staging area. This is the differencies that will be committed

'Message' lets you enter a commit message

The diff view lets you review the differences of the selected file. In this view:
- Ctrl+Click on an added or removed line stages/unstages the line
- Ctrl+Click on an hunk header (purple lines) stages/unstages the complete hunk

![Image of log tree](https://bitbucket.org/alberthier/git-webui/raw/master/doc/img/workspace.png)

## Dependencies

### Runtime
- git (of course :) )
- python 2.7+ or python 3.0+ (Generally already installed on your Mac / Linux)
- An up-to-date modern browser

### Development
- Runtime dependencies and ...
- node.js
- grunt-cli

## Uninstallation

Using curl (Mac OS X):
```
curl https://raw.github.com/alberthier/git-webui/install/uninstaller.sh | bash
```

Using wget (Linux):
```
wget -O - https://raw.github.com/alberthier/git-webui/install/uninstaller.sh | bash
```

## Author

[<NAME>](mailto:<EMAIL>) ([@eric_alber](https://twitter.com/eric_alber))

## License

This software is licensed under the [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) license
<commit_msg>Fix alternate text in readme<commit_after># Git WebUI

This git extension intends to become your everyday git companion. Run it from
any of your repositories and it will provide you a web based user interface for it.

It comes with history and tree browsing. You may also use this interface to commit
as it comes with a diff review UI and the ability to stage / unstage code.

Moreover as git-webui is also a web server, your repository is accessible to
other people on the same network. They can clone or pull your code using the
same URL.

It has very few dependencies, you probably already have them on your
Mac / Linux : git, python, and a web browser

## Installation

The following command will install git-webui in `$HOME/.git-webui` and add a
`webui` alias to your global `.gitconfig` file

Using curl (Mac OS X):
```
curl https://raw.github.com/alberthier/git-webui/install/installer.sh | bash
```

Using wget (Linux):
```
wget -O - https://raw.github.com/alberthier/git-webui/install/installer.sh | bash
```

Upon installation git-webui will update itself automatically every couple of weeks

## Usage

### Starting

First cd to any of your project versionned with git
```
cd <my-local-git-clone>
git webui
```

This will start an http server and open your default browser with the GUI

### History Viewing

The toolbar on the left shows your branches and tags. The log of the currently selected one is displayed.

When selecting a revision the diff of this specific commit is displayed in the right panel.

On top of the right panel, you can choose 'Tree' to display the versionned content at the specific
revision selected in the left panel. You can browse through directories and display file contents.

![Image of log commit](https://bitbucket.org/alberthier/git-webui/raw/master/doc/img/log-commit.png)
![Image of log tree](https://bitbucket.org/alberthier/git-webui/raw/master/doc/img/log-tree.png)

### Remote access

Other people on your network have read-only access to your repository: they may clone or pull
from your repository through the same url:

Clone:
```
$ git clone http://<ip_of_the_computer_running_webui>:8000/ repo_name
```

Pull:
```
$ git pull http://<ip_of_the_computer_running_webui>:8000/
```

### Commit

Commits can only be made from localhost.

'Working copy' lists the files modified (compared to the staging area) in your working directory

'Staging area' lists the files modified (compared to HEAD) in your staging area. This is the differencies that will be committed

'Message' lets you enter a commit message

The diff view lets you review the differences of the selected file. In this view:
- Ctrl+Click on an added or removed line stages/unstages the line
- Ctrl+Click on an hunk header (purple lines) stages/unstages the complete hunk

![Image of the workspace](https://bitbucket.org/alberthier/git-webui/raw/master/doc/img/workspace.png)

## Dependencies

### Runtime
- git (of course :) )
- python 2.7+ or python 3.0+ (Generally already installed on your Mac / Linux)
- An up-to-date modern browser

### Development
- Runtime dependencies and ...
- node.js
- grunt-cli

## Uninstallation

Using curl (Mac OS X):
```
curl https://raw.github.com/alberthier/git-webui/install/uninstaller.sh | bash
```

Using wget (Linux):
```
wget -O - https://raw.github.com/alberthier/git-webui/install/uninstaller.sh | bash
```

## Author

[<NAME>](mailto:<EMAIL>) ([@eric_alber](https://twitter.com/eric_alber))

## License

This software is licensed under the [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) license

{'fraction_non_alphanumeric': 0.09525147513346445, 'fraction_numerical': 0.00449564484405732, 'mean_word_length': 4.192560175054704, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 16, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6825247', 'n_tokens_mistral': 2182, 'n_tokens_neox': 2075, 'n_words': 896}