{"id":16272120,"url":"https://github.com/syu-fu/gh-dot-tmpl","last_synced_at":"2026-05-04T07:40:06.068Z","repository":{"id":244626885,"uuid":"812655348","full_name":"Syu-fu/gh-dot-tmpl","owner":"Syu-fu","description":"GitHub CLI extension that generates the contents of the `.github` folder from templates.","archived":false,"fork":false,"pushed_at":"2025-03-24T19:30:37.000Z","size":66,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T08:04:22.331Z","etag":null,"topics":["github","github-cli","github-cli-extension","template"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Syu-fu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-09T14:08:40.000Z","updated_at":"2025-03-19T06:50:35.000Z","dependencies_parsed_at":"2024-06-16T08:24:26.325Z","dependency_job_id":"dc24cabc-36d6-4138-aa77-53a1387bd4ab","html_url":"https://github.com/Syu-fu/gh-dot-tmpl","commit_stats":null,"previous_names":["syu-fu/gh-dot-tmpl"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syu-fu%2Fgh-dot-tmpl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syu-fu%2Fgh-dot-tmpl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syu-fu%2Fgh-dot-tmpl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syu-fu%2Fgh-dot-tmpl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Syu-fu","download_url":"https://codeload.github.com/Syu-fu/gh-dot-tmpl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247874268,"owners_count":21010629,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","github-cli","github-cli-extension","template"],"created_at":"2024-10-10T18:16:17.002Z","updated_at":"2026-05-04T07:40:00.980Z","avatar_url":"https://github.com/Syu-fu.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gh-dot-tmpl\n\n[![lint](https://github.com/Syu-fu/gh-dot-tmpl/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/Syu-fu/gh-dot-tmpl/actions/workflows/lint.yml)\n[![check license](https://github.com/Syu-fu/gh-dot-tmpl/actions/workflows/license-check.yml/badge.svg?branch=main)](https://github.com/Syu-fu/gh-dot-tmpl/actions/workflows/license-check.yml)\n[![test](https://github.com/Syu-fu/gh-dot-tmpl/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Syu-fu/gh-dot-tmpl/actions/workflows/test.yml)\n[![Go Coverage](https://github.com/Syu-fu/gh-dot-tmpl/wiki/coverage.svg)](https://raw.githack.com/wiki/Syu-fu/gh-dot-tmpl/coverage.html)\n\n`gh-dot-tmpl` is a GitHub CLI extension that generates the contents of the `.github` folder from templates.  \nIt helps in automating and standardizing the setup of GitHub repository configurations.\n\n## Dependencies\n\n`gh-dot-tmpl` requires the following dependencies:\n\n- `gh` (GitHub CLI) version 2.51.0 or higher\n- `git` version 2.45.2 or higher\n\nEnsure that these dependencies are installed and properly configured before using `gh-dot-tmpl`.\n\n## Installation\n\n```shell\ngh extension install Syu-fu/gh-dot-tmpl\n```\n\nUpgrade:\n\n```shell\ngh extension upgrade dot-tmpl\n```\n\n## Usage\n\n### Running the Command\n\n1. **Generate files from templates:**\n\nTo generate the contents of the `.github` folder from specified templates, use the following command:\n\n```sh\ngh dot-tmpl [TEMPLATE_NAME1] [TEMPLATE_NAME2] ...\n```\n\nReplace [TEMPLATE_NAME1], [TEMPLATE_NAME2], etc., with the names of the templates you want to use.\n\n### Command Flags\n\n| Flag          | Description                 |\n| ------------- | --------------------------- |\n| -h, --help    | Display help information    |\n| -v, --version | Display version information |\n\n### Configuration\n\nThe location for the configuration file is `$XDG_CONFIG_HOME/gh-dot-tmpl/config.yaml`.\n\n#### Configuration File Example\n\nBelow is an example of a configuration file (config.yaml):\n\n```yaml\ntemplates:\n  issue:\n    template_file: ~/.config/gh-dot-tmpl/template/issue.md\n    output_file: .github/ISSUE_TEMPLATE.md\n  pr:\n    template_file: ~/.config/gh-dot-tmpl/template/pullrequest.md\n    output_file: .github/PULL_REQUEST_TEMPLATE.md\n```\n\n| Key           | Description                                                                           |\n| ------------- | ------------------------------------------------------------------------------------- |\n| templates     | A mapping of template names to their respective template files and output file names. |\n| template_file | The name of the template file to use.                                                 |\n| output_file   | The name of the file to generate.                                                     |\n\n### Templates\n\nTemplate files should be placed under `$XDG_CONFIG_HOME/gh-dot-tmpl/template/`.\n\nTemplate Replacements\nThe following placeholders can be used in template files and will be replaced accordingly:\n\n| Placeholder     | Description                        |\n| --------------- | ---------------------------------- |\n| {{.Username}}   | Replaced with the GitHub username. |\n| {{.Repository}} | Replaced with the repository name. |\n\nFor example, a template file (issue.md) might look like this:\n\n```md\n---\nname: Bug report\nabout: Create a report to help us improve\ntitle: \"\"\nlabels: \"\"\nassignees: \"\"\n---\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**To Reproduce**\nSteps to reproduce the behavior:\n\n1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Screenshots**\nIf applicable, add screenshots to help explain your problem.\n\n**Information:**\n\n- OS:\n- {{.Reponame}} Version:\n\n**Additional context**\nAdd any other context about the problem here.\n```\n\n## Contributing\n\nWe welcome contributions to gh-dot-tmpl! Please see the [CONTRIBUTING.md](https://github.com/Syu-fu/gh-dot-tmpl/blob/main/.github/CONTRIBUTING.md) file for guidelines on how to contribute to this project.\n\n## License\n\nDistributed under the [MIT License](https://github.com/Syu-fu/gh-dot-tmpl/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyu-fu%2Fgh-dot-tmpl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyu-fu%2Fgh-dot-tmpl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyu-fu%2Fgh-dot-tmpl/lists"}