System Requirements

Install the following programs to configure your dev environment.

Programs marked with an asterik * are required for HaTs to work.

Node

• Node (v11.14 or higher)*

Git + GitHub CLI

• Git (v2.3 or higher)*
• GitHub CLI (latest stable version is recommended)*

One of the core benefits you receive each time you bootstrap a new project with hats create is automatic synchronization between your local repository and a fresh GitHub remote. Under the hood, HaTs leverages the GitHub CLI to facilitate this tethering.

Note: The GitHub CLI must have permission to create repos for the GitHub account or organization that will own the remote, for instance via an SSH key on your machine. A tutorial for configuring SSH access to GitHub is linked here.

Verify your GitHub CLI Configuration

1. Verify the GitHub CLI version

$ gh version
gh version 2.6.0 (2022-03-15)
https://github.com/cli/cli/releases/tag/v2.6.0

2. Login to GitHub and verify your Auth status (SSH Example)

$ gh auth status
github.com
  ✓ Logged in to github.com as <gh-username> (/Users/<shell-username>/.config/gh/hosts.yml)
  ✓ Git operations for github.com configured to use ssh protocol.
  ✓ Token: *******************

$ gh ssh-key list
GitHub CLI                    ssh-ed25519 AAAAC...****************  15d

Helper Programs

The following programs highly recommended for your TypeScript projects.

• Changelog Automation: auto-changelog
• Markdown Table of Contents Automation: doctoc