Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2kabhishek/mkrepo
Ready to go repos from the CLI ✈💡
https://github.com/2kabhishek/mkrepo
bash developer-tools github rapid-development utilities
Last synced: 4 days ago
JSON representation
Ready to go repos from the CLI ✈💡
- Host: GitHub
- URL: https://github.com/2kabhishek/mkrepo
- Owner: 2KAbhishek
- License: gpl-3.0
- Created: 2020-12-12T07:28:50.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-29T10:41:48.000Z (12 months ago)
- Last Synced: 2024-05-01T16:27:03.872Z (7 months ago)
- Topics: bash, developer-tools, github, rapid-development, utilities
- Language: Shell
- Homepage:
- Size: 39.1 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## What is this
mkrepo is a little wrapper around `github-cli` that allows you to make new repos even more quickly and sets up remotes so that you can jump straight into typing out code.
## Inspiration
I make a lot of projects (as you might have seen on my GitHub profile), and I needed a tool to fasttrack the first commit.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of `github-cli`
- A template repo like [mkrepo](https://github.com/2kabhishek/mkrepo)
## Installing mkrepo
To install mkrepo, follow these steps:
```bash
git clone https://github.com/2kabhishek/mkrepo
cd mkrepo
# Link mkrepo to a directory that's in PATH (~/.local/bin here)
ln -sfnv "$PWD/mkrepo.sh" ~/.local/bin/mkrepo
```
## Using mkrepo
If you have an existing project, you can use `mkrepo project_dirname` to create a new repo with the same name, and it will automatically set things up for you.
For new repos you can use `mkrepo` to create a new repo that uses the template you pass (mkrepo if empty) for setting things up.
```bash
mkrepo: Ready to go repos from the CLI 🚀💡
Usage: mkrepo [templateName] [description]
Arguments:
repo name: The name of the new repository.
template name: The name of the template repo to use (default: bare-minimum).
description: The description for the repository (default: Short Sweet Headline 🎇🎉).
```
## Templates
These are some templates I have set up and use:
- [bare-minimum](https://github.com/2kabhishek/bare-minimum): General purpose template (default)
- [tiny-web](https://github.com/2kabhishek/tiny-web): Template for calssic web pages
- [shelly](https://github.com/2kabhishek/shelly): Template for CLI tools
## How it was built
mkrepo was built using `bash` and `gh`
## What's next
Needs changes to support customization for other users.
Hit the ⭐ button if you found this useful.
## More Info
