[ DOCUMENTATION ]
Install Hearth
Install the command, sign in and run your first check in about two minutes.
ON THIS SITE
Hearth runs on macOS and Linux, and on Windows through its Linux subsystem. You need a terminal and a project that lives in a version-controlled folder.
1. Install
Run the install line from the home page. It downloads one file, puts it on your path and prints the version. Nothing else on your machine is changed.
2. Sign in
Run hearth login. A browser tab opens, you approve the sign-in, and the terminal confirms. You can also set a key in an environment variable if you work on a server.
3. Check the setup
Run hearth doctor. It checks your version, your sign-in and whether it can see your project. Each line is a tick or a short instruction to fix it.
Was this page helpful?
Yes
Not quite
