https://github.com/therebelrobot/mirror-cli

Command line utility for 1:1 mirroring of Github repos
https://github.com/therebelrobot/mirror-cli

Last synced: 9 days ago
JSON representation

Command line utility for 1:1 mirroring of Github repos

• Host: GitHub
• URL: https://github.com/therebelrobot/mirror-cli
• Owner: therebelrobot
• License: isc
• Created: 2015-11-16T18:42:29.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-18T23:06:15.000Z (about 9 years ago)
• Last Synced: 2024-12-23T11:04:47.738Z (17 days ago)
• Language: JavaScript
• Size: 11.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mirror-cli

[![NPM](https://nodei.co/npm/mirror-cli.png?downloads=true)](https://nodei.co/npm/mirror-cli/)

[![NPM](https://nodei.co/npm-dl/mirror-cli.png?months=3&height=2)](https://nodei.co/npm/mirror-cli/)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)

[![Dependency Status](https://david-dm.org/therebelrobot/mirror.svg)](https://david-dm.org/therebelrobot/mirror)

A node utility to manually clone Github repositories. *with bonus CLI!*

 Github, by design, restricts the number of times you can fork a repo into a single account. Even then, after forking, you are bound to the upstream in your repo page, which if you are doing an iterative work can sometimes be a hinderance to marketing. There are [hacks](https://adrianshort.org/create-multiple-forks-of-a-github-repo/) and [workarounds](https://help.github.com/articles/duplicating-a-repository/) for this, but **mirror** allows you to manually clone a repo with a single command.

## Installation

```bash

npm i -g mirror-cli

```

## Usage

To use mirror, you'll need to generate a Github Personal Access Token, [found here](https://github.com/settings/tokens). You should only grant this token the permissions it needs, which is ***repo***. (If you discover it needs other permissions besides that, lemme know)

### CLI

```bash

mirror account/repo to other-account/other-repo -u username -t token

```

If you add your username and token to your environment under the variables `GITHUB_USER` and `GITHUB_TOKEN`, the command below will do the same thing:

```bash

mirror account/repo to other-account/other-repo

```

If you want to create the new repo from scratch, just add the flag `--create` or `-c`

```

Usage:

  mirror [OPTIONS] [ARGS]

Options:

  -u, --user [STRING]    Your Github Username (Default is username-from-environment)

  -t, --token [STRING]   Your Github Access Token (Default is token-from-environment)

  -f, --force BOOL       force push target branch

  -c, --create BOOL      create target repo on Github

  -k, --no-color         Omit color from output

      --debug            Show debug information

  -v, --version          Display the current version

  -h, --help             Display help and usage details

```

## Contributing

### What is needed

Moar tests

## License

ISC