hipcheck icon indicating copy to clipboard operation
hipcheck copied to clipboard

Add an `hc doctor` command that checks if Hipcheck is ready to run

Open alilleybrinker opened this issue 1 year ago • 3 comments

Hipcheck requires some files to be present / findable by it in order to run. Currently, these are checked at the start of running Hipcheck, but it checks them one by one and doesn't give a convenient way to check the full readiness of Hipcheck to execute. While this can also be improved in the hc check flow, it would be nice to have a separate command that checks Hipcheck's readiness to run by looking for configuration, data files, and a place to put clones, and reports everything it finds. This would also help people to debug if they feel like Hipcheck found inferred the wrong location.

alilleybrinker avatar Apr 23 '24 16:04 alilleybrinker

This could also support the deprecation of the --print-config, --print-data, --print-home flag commands, which is ideal. I don't really like that we've made it so some flags run commands instead.

alilleybrinker avatar Apr 23 '24 16:04 alilleybrinker

The hc doctor command should also give instructions for fixing any problems it identifies, like missing helper scripts or lack of configuration files. This would also help ease the workflow of people installing just the Hipcheck binary through something like cargo binstall or an Axo install script in the future.

alilleybrinker avatar Apr 23 '24 16:04 alilleybrinker

Also open to a different name for this command.

alilleybrinker avatar Apr 25 '24 17:04 alilleybrinker