https://github.com/dhruwlalan/quickrepo
A simple command to quickly create a github repository.
https://github.com/dhruwlalan/quickrepo
git github node-cli repository
Last synced: 5 months ago
JSON representation
A simple command to quickly create a github repository.
- Host: GitHub
- URL: https://github.com/dhruwlalan/quickrepo
- Owner: dhruwlalan
- License: mit
- Created: 2021-02-10T06:21:57.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-03T15:23:07.000Z (over 3 years ago)
- Last Synced: 2025-07-06T23:37:35.364Z (6 months ago)
- Topics: git, github, node-cli, repository
- Language: TypeScript
- Homepage: http://npm.im/@dhruwlalan/quickrepo
- Size: 210 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# quickrepo
> A single command to quickly create a repository locally & also host it on github.
[](https://github.com/dhruwlalan/quickrepo/blob/master/LICENSE) [](https://www.npmjs.com/package/quickrepo) [](https://www.npmjs.com/package/quickrepo)
## Why?
Creating repository and hosting it on Github feels quite repetitive & contains quite a few steps _(initializing local repo → create new repo on Github → add remote → push to Github)_ if you are someone who creates a lot of repositories _(in this way)_.
With `quickrepo` all you have to do is just run the command `$ qr init`, enter remote repository details and **DONE**.
`quickrepo` will create the local repository _(if it is already not a git repository or else it will just host it)_ , create the remote repository, add the remote, push to Github. _(It will also set the local branch to track the remote branch i.e up-stream branch)_ .
## Installation
```
$ npm install -g @dhruwlalan/quickrepo
```
## Prerequisites
- Make sure you have [node](https://nodejs.org/en/) and [git](https://git-scm.com/) installed.
- You will also need to generate a github [personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token#creating-a-token) with the scope of `repo` checked. The generated token will be required when setting up your app so store it somewhere temporarily or copy it into the clipboard.
## Usage
**First**, run the below command to setup the app by providing the github personal access token that you generated and copied.
You will get the input prompt for pasting in the personal access token.
```bash
$ qr setup
```
> you only need to run the setup once **_or_** if the stored token becomes invalid **_or_** if you purposely want to override the stored token with a new token.
**Second**, run the below command inside any directory you wish to make it a git repository & also host it onto github.
```bash
$ qr init
```
> This command will automatically set up your local repository's remote (with the name origin) linked with the created host repository on github so you need not have to worry about it!
## Available Commands
| command | description |
| ----------- | ------------------------------------------------------------- |
| `qr setup` | To setup the app by providing github's personal access token. |
| `qr verify` | To verify the stored token if its valid or invalid. |
| `qr init` | To create a repository locally & host it onto github. |
## License
[MIT](https://github.com/dhruwlalan/quick-repository/blob/master/LICENSE) © 2021 [dhruw lalan](https://github.com/dhruwlalan)