{"id":13432504,"url":"https://github.com/alberthier/git-webui","last_synced_at":"2025-03-17T09:31:31.104Z","repository":{"id":20954742,"uuid":"24243349","full_name":"alberthier/git-webui","owner":"alberthier","description":"A standalone local web based user interface for git repositories","archived":false,"fork":false,"pushed_at":"2022-12-15T17:17:55.000Z","size":1329,"stargazers_count":831,"open_issues_count":24,"forks_count":119,"subscribers_count":43,"default_branch":"master","last_synced_at":"2024-02-14T17:32:54.796Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alberthier.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-19T19:52:16.000Z","updated_at":"2024-02-04T09:37:28.000Z","dependencies_parsed_at":"2023-01-11T21:02:06.648Z","dependency_job_id":null,"html_url":"https://github.com/alberthier/git-webui","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alberthier%2Fgit-webui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alberthier%2Fgit-webui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alberthier%2Fgit-webui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alberthier%2Fgit-webui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alberthier","download_url":"https://codeload.github.com/alberthier/git-webui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244009077,"owners_count":20382964,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T02:01:12.504Z","updated_at":"2025-03-17T09:31:30.672Z","avatar_url":"https://github.com/alberthier.png","language":"JavaScript","readme":"# Git WebUI\n\nThis git extension is a standalone web based user interface for git repositories.\n\nIt comes with history and tree browsing. You may also use it to commit\nas it comes with an UI to review local changes and the ability to stage / unstage code.\n\nMoreover as git-webui is a web server, your repository is accessible to\nother people on the same network. They can clone or pull your code using the\nsame URL.\n\nIt has very few dependencies, you probably already have them on your\nMac / Linux : git, python, and a web browser.\n\n## Installation\n\n### Automatic (Do you trust me ?)\n\nThe following command will install git-webui in `$HOME/.git-webui` and add a\n`webui` alias to your global `.gitconfig` file.\n\n*Note for Windows users:* These install scripts work for you too. Run them from your Git-Bash shell.\nYou need to install [Python](https://www.python.org/downloads/) first.\n\nUsing curl (Mac OS X \u0026 Windows):\n```\ncurl https://raw.githubusercontent.com/alberthier/git-webui/master/install/installer.sh | bash\n```\n\nUsing wget (Linux):\n```\nwget -O - https://raw.githubusercontent.com/alberthier/git-webui/master/install/installer.sh | bash\n```\n\nUpon installation git-webui will update itself automatically every couple of weeks.\nYou can deactivate auto-update by removing the `autoupdate = true` line from the\n`webui` section of your global `.gitconfig` file.\n\n### Manual\n\nSimply clone the repository and install the alias\n\n```\ngit clone https://github.com/alberthier/git-webui.git\ngit config --global alias.webui \\!$PWD/git-webui/release/libexec/git-core/git-webui\n```\n\nIf you want to allow auto-update:\n```\ngit config --global webui.autoupdate true\n```\n\n## Usage\n\n### Starting\n\nFirst cd to any of your project versioned with git\n```\ncd \u003cmy-local-git-clone\u003e\ngit webui\n```\n\nThis will start an embedded HTTP server and open your default browser with the GUI.\n\n### History Viewing\n\nThe toolbar on the left shows your branches and tags. The log of the currently selected one is displayed.\n\nWhen selecting a revision the diff of this specific commit is displayed in the right panel.\n\n![Image of log commit](https://raw.githubusercontent.com/alberthier/git-webui/master/src/share/git-webui/webui/img/doc/log-commit.png)\n\nOn top of the right panel, you can choose 'Tree' to display the versioned content at the specific\nrevision selected in the left panel. You can browse through directories and display file contents.\n\n![Image of log tree](https://raw.githubusercontent.com/alberthier/git-webui/master/src/share/git-webui/webui/img/doc/log-tree.png)\n\n### Remote access\n\nOther people on your network have read-only access to your repository:\nthey may access to the web interface (without 'Workspace'), clone or pull from your repository.\nAll this through the same url:\n\nClone:\n```\n$ git clone http://\u003cip_of_the_computer_running_webui\u003e:8000/ repo_name\n```\n\nPull:\n```\n$ git pull http://\u003cip_of_the_computer_running_webui\u003e:8000/\n```\n\n### Commit\n\nCommits can only be made from localhost.\n\n![Image of the workspace](https://raw.githubusercontent.com/alberthier/git-webui/master/src/share/git-webui/webui/img/doc/workspace.png)\n\n- **Working copy** lists the modified files (compared to the staging area) in your working directory\n- **Message** lets you enter a commit message\n- **Staging area** lists the modified files (compared to HEAD) in your staging area. These are the changes that will be committed\n\nThe diff view lets you review the differences of the selected file.\nYou can select code in more fine grained way:\n- If the displayed diff is from the working copy, you may stage or cancel the selected lines.\n- If the displayed diff is from the staging area, you may unstage the selected lines.\n\n## Dependencies\n\n### Runtime\n\n- git (of course :) )\n- python 2.7+ or python 3.0+ (Generally already installed on your Mac / Linux)\n- An up-to-date modern browser\n\n### Development\n\n- Runtime dependencies and ...\n- node.js\n- grunt-cli\n\n## Uninstallation\n\n### Automatic\n\nUsing curl (Mac OS X \u0026 Windows):\n```\ncurl https://raw.githubusercontent.com/alberthier/git-webui/master/install/uninstaller.sh | bash\n```\n\nUsing wget (Linux):\n```\nwget -O - https://raw.githubusercontent.com/alberthier/git-webui/master/install/uninstaller.sh | bash\n```\n\n### Manual\n\n```\nrm -rf \u003cgit-webui-clone-path\u003e\ngit config --global --unset-all alias.webui\ngit config --global --remove-section webui\n```\n\n## Contributing\n\nYou can clone the source code of [git-webui on GitHub](https://github.com/alberthier/git-webui)\n\nAfter executing `grunt` git-webui is available in the `dist` folder.\n\nPlease don't commit any content to the `release` folder. This is for end-users release versions, not for work-in-progress versions\n\n## Packaging\n\nIf you want to build a DEB, RPM or Homebrew package for git-webui, you only need the content of the `release` folder.\n\nInstalling git-webui globally on the system is nothing else than\n```\ncp -rf release/* /usr\n```\n\n## Limitations\n\n- If you have no web browser installed at all (headless server), you should start git webui with the `--no-browser` option. Otherwise git-webui may freeze searching for a browser.\n\n## Author\n\n[Éric ALBER](mailto:eric.alber@gmail.com) ([@eric_alber](https://twitter.com/eric_alber))\n\n## License\n\nThis software is licensed under the [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) license\n","funding_links":[],"categories":["JavaScript","Software","others","Software Development","Version Control System \"VCS\""],"sub_categories":["Software Development - Project Management","Project Management"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falberthier%2Fgit-webui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falberthier%2Fgit-webui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falberthier%2Fgit-webui/lists"}