ausi / remote-git
Edit git repositories remotely
Fund package maintenance!
0.2.6
2026-01-09 10:51 UTC
Requires
- php: ^8.1
- symfony/filesystem: ^5.3 || ^6.0 || ^7.0 || ^8.0
- symfony/process: ^5.3 || ^6.0 || ^7.0 || ^8.0
Requires (Dev)
- amphp/dns: ^v2.4.0
- amphp/socket: ^v2.3.1
- contao/easy-coding-standard: ^6.3.1
- phpstan/phpstan: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpstan/phpstan-symfony: ^1.0
- phpunit/phpunit: ^9.6.31
- psalm/plugin-phpunit: ^0.19
- slam/phpstan-extensions: ^6.0
- symfony/console: ^5.3 || ^6.0 || ^7.0 || ^8.0
- vimeo/psalm: ^6.14.3
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
This library provides methods to handle git repositories remotely without having to clone the whole repo. It uses the Symfony process component to run the git client.
Usage
<?php use Ausi\RemoteGit\Repository; use Ausi\RemoteGit\GitObject\File; use Ausi\RemoteGit\Exception\ConnectionException; use Ausi\RemoteGit\Exception\PushCommitException; $repo = new Repository('ssh://git@github.com/ausi/remote-git.git'); try { $repo->connect(); } catch(ConnectionException $exception) { // Unable to connect to the specified server } $headCommit = $repo->getBranch('main')->getCommit(); $newTree = $headCommit ->getTree() ->withFile( 'example.txt', 'Example content…', ) ; $newCommit = $repo->commitTree($newTree, 'Add example', $headCommit); try { $repo->pushCommit($newCommit, 'main'); } catch(PushCommitException $exception) { // Unable to push to the specified remote, e.g. no write access }
Installation
To install the library use Composer or download the source files from GitHub.
composer require ausi/remote-git
Speed
Speed comparison of cloning https://gitlab.com/linux-kernel/stable.git and reading the contents of a file:
| Command | Network | Disk Space | Time |
|---|---|---|---|
git clone |
3.21 GB | 4.6 GB | 901 s |
git clone --depth 1 |
207 MB | 1.4 GB | 77 s |
git clone -n --depth 1 |
207 MB | 216 MB | 46 s |
getBranch(…)->getCommit()->getTree()->getFile(…)->getContents() |
2.49 MB | 2.57 MB | 5.8 s |
Naturally, this is strongly dependent on many factors like bandwidth and CPU power and should only give a rough idea of this projects purpose, namely reading or writing small bits of data from or to a remote GIT repository.