README.md

November 29, 2023 · View on GitHub

mkrepo

Ready to go repos from the CLI ✈💡

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

Installing mkrepo

To install mkrepo, follow these steps:

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.

mkrepo: Ready to go repos from the CLI 🚀💡

Usage: mkrepo <repoName> [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: General purpose template (default)
tiny-web: Template for calssic web pages
shelly: Template for CLI tools