# @swimauger/gitproxy

> A Node.js package for running git over a proxy

Latest version **1.0.1** (published 2020-06-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @swimauger/gitproxy
pnpm add @swimauger/gitproxy
yarn add @swimauger/gitproxy
bun add @swimauger/gitproxy
```

Provides the command `gitproxy`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-06-14 |
| First published | 2020-06-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 24.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mark Auger |
| Maintainers | swimauger |
| Keywords | Git, Proxy, GitProxy, GitHub |

## Links

- npm: https://www.npmjs.com/package/@swimauger/gitproxy
- Repository: https://github.com/swimauger/gitproxy
- Homepage: https://github.com/swimauger/gitproxy#readme
- Issues: https://github.com/swimauger/gitproxy/issues
- npm.io page: https://npm.io/package/@swimauger/gitproxy

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [commander](https://npm.io/package/commander.md) ^5.1.0

## Recent versions

- 1.0.1 (latest) — 2020-06-14
- 1.0.0 — 2020-06-14

## README

# GitProxy Node.js Package

![](https://img.shields.io/npm/dw/@swimauger/gitproxy?style=for-the-badge)
![](https://img.shields.io/npm/v/@swimauger/gitproxy?style=for-the-badge)
![](https://img.shields.io/github/license/swimauger/gitproxy?style=for-the-badge)

Node.js package built for running git commands over a proxy

| NOTE: GitProxy uses the `git` command to run over a proxy, so please be sure [Git](https://git-scm.com/downloads) is installed before proceeding! |
| :-----------------------------------------------------------------------------------------------------------------------------------------------: |


## Installation

**Install gitproxy**
`npm install @swimauger/gitproxy -g`

## Usage
```
    Usage: gitproxy [options]

    If no options are selected it will treat the command like git

    Options:
    -u, --up <protocol>    open proxy with protocol http or https
    -d, --down <protocol>  shutdown proxy with protocol http or https
    -l, --list             list current proxies
    -h, --help             display help for command
```
## Examples

### Running normal git
```Shell
    gitproxy push origin master
```
Treat gitproxy like a normal git command. For instance `git add .` would be `gitproxy add .`

#

### GitProxy can also be used interchangably with normal Git
```Shell
    git add -A
    git commit -m "A very urgent test commit"
    gitproxy push origin master
```
GitProxy mostly serves a purpose for pushing to repos and such. For example `gitproxy status` does not really serve any purpose over the normal `git status`. That said, feel free to use however you like : )

#

### Edit git config proxies
```Shell
    # Open up a new https proxy in the git config
    gitproxy -u https

    # Delete the http proxy in the git config
    gitproxy -d http
```
GitProxy can set a new random proxy for you in the gitconfig; however, by running `gitproxy` as a git command, it could overwrite the old proxy with a new one under the conditions that the repo is using the same SSL protocol

#

### List git config proxies
```Shell
      gitproxy -l

# ======= OR ======= #

    gitproxy --list
```
`gitproxy -l` will list open proxies on either http or https and if there are any.

#

### Help
```Shell
    gitproxy -h
```
If you are ever stuck refer to the help menu with `gitproxy -h` or `gitproxy --help`. You can also see the different flag names there are.

---
_Source: https://npm.io/package/@swimauger/gitproxy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._