gh-template

Project Template Extension

A GitHub CLI extension to format a project template.

Install

Make sure you have version 2.0 or newer of the GitHub CLI installed.

gh extension install heaths/gh-template

Usage

To create a new repository from a template and format it:

gh repo clone <name> --template <template> --clone
cd <template>
gh template apply

Templates

You can format files in a template repository as template files. Template files contain a mix of text and actions surrounded by {{ and }} e.g.,

# {{param "name" "" "What is the project name?" | titlecase}}

This is an example repository {{param "github.owner"}}/{{param "github.repo"}}.

You'll be prompted for any parameters not specified on the command line or already defined by the apply command.

Built-in parameters

Within a GitHub repository, the following parameters are already defined.

• github.host
  The GitHub host e.g., "github.com" for "github.com/heaths/gh-template".
• github.owner
  The GitHub owner e.g., "heaths" for "github.com/heaths/gh-template".
• github.repo
  The GitHub repository name e.g., "gh-template" for "github.com/heaths/gh-template".

Functions

In addition to built-in functions, the following functions are also available:

• param <name> [<default> [<prompt>]]
  Replace with a parameter named <name>, or prompt using an optional <default> with an optional <prompt>. If a <prompt> is not specified, the required <name> is used.
• pluralize <count> <thing>
  Append an "s" to <thing> if <count> is not equal to 1. <count> can be either an int or a string representing an int e.g., "1".
• lowercase <string>
  Change the case of <string> to all lowercase characters.
• titlecase <string>
  Change the case of <string> to Title Case characters.
• uppercase <string>
  Change the case of <string> to UPPERCASE characters.

License

Licensed under the MIT license.