Skip to content

Transform any GitHub repository into your project template

License

Notifications You must be signed in to change notification settings

1Shubham7/templ8

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Templ8

GitHub last commit GitHub language count GitHub top language codecov

▀▀█▀▀ ▒█▀▀▀ ▒█▀▄▀█ ▒█▀▀█ ▒█░░░ ▒█▀▀▀█
░▒█░░ ▒█▀▀▀ ▒█▒█▒█ ▒█▄▄█ ▒█░░░ █░▄▄▄█░
░▒█░░ ▒█▄▄▄ ▒█░░▒█ ▒█░░░ ▒█▄▄█ █▄▄▄▄█░

🚀 Transform any GitHub repository into your project template

templ8 simplifies project bootstrapping by creating templates from existing GitHub repos.
Just provide a repository URL and branch name - templ8 handles the rest.

Usage:
  templ8 <github-repo-url> -b=<branch-name> -d=<distination>

Happy coding! ✨

Templ8 is a CLI tool that helps you bootstrap projects quickly by transforming any GitHub repository into a template. With just the repository URL and branch name, Templ8 takes care of the rest, saving you time on repetitive setup tasks.

Whether you're starting a new project or creating a template for your team, Templ8 makes it easy to clone and customize GitHub repositories with a few commands.

⭐ Star us on GitHub — it motivates me a lot!

Share Share Share Share Share

📚Tech Stack

  • Language: Golang
  • Tools: Cobra CLI
  • APIs: GitHub API
  • CI Pipeline: GitHub Actions

Installing

Follow these steps to install and set up Templ8:

  1. Visit the Releases section of the Templ8 repository and download the latest stable release.

  2. Open your shell configuration file (e.g., ~/.bashrc or ~/.zshrc) in a text editor:

    nano ~/.bashrc
  3. Add the following line at the end of the file to include the directory in your PATH (replace PATH_TO_EXECUTABLE with the actual path to your downloaded executable):

    export PATH=$PATH:[PATH_TO_EXECUTABLE]
  4. Save and close the file:

    • For nano: Press Ctrl+O, then Enter, and Ctrl+X.
  5. Reload the shell configuration:

    source ~/.bashrc
  6. Navigate to the directory where you placed the CLI executable:

    cd [PATH_TO_EXECUTABLE]
  7. Make the executable file runnable:

    chmod +x templ8.exe
  8. Verify the installation by running the following command:

    templ8.exe --help
  9. Additionally you can also rename the templ8.exe to templ8:

    mv templ8.exe templ8

You're all set to transform any GitHub repository into a template! 🎉

Usage

Simply call the executable with the URL of the repository you want to use as a template, and the tool will download the latest version of the specified branch into the directory you want and initialize it as a new repository.

templ8 https://github.com/1Shubham7/demo-repo-for-templ8

Optional Arguments

You can specify additional options such as a different branch or output directory:

  • Specify a branch: Use the --branch or -b flag to specify a branch to clone.
  • Set an output folder: Use the -distination or -d flag to set the name of the folder where the contents will be placed.

Example:

# This will create a folder called 'new-proj' with the contents of the source repo, specifically the 'dev' branch.
templ8 -b=dev -d=new-proj https://github.com/1Shubham7/demo-repo-for-templ8

About

Transform any GitHub repository into your project template

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published