src-d / hercules

Gaining advanced insights from Git repository history.
Other
2.59k stars 264 forks source link

Where are the output files? #394

Open Erotemic opened 1 year ago

Erotemic commented 1 year ago

I'm finding the documentation about how to run hercules to be unclear. I have both it and labours installed, but every variant of the command I'm trying doesn't sem to output anything to disk.

As I'm writing this and fiddling with the program I'm realizing that the output is stdout based and it needs to be piped to labours.

The README should contain a clear example of running the process on an existing cloned repo, ideally with intermediate files. Something like:

    hercules --burndown ./.git > burndown_output
    cat burndown_output | labours -m burndown-project -o git_git.png

would have made it more clear to me how to use the program. I'm still not sure why I don't see the advertised cache directory being written, but at least I've got a sense of why I saw no output before.