doculog icon indicating copy to clipboard operation
doculog copied to clipboard

Add Basic CLI

Open Seniatical opened this issue 3 years ago • 8 comments

Instead of forcefully creating a changelog add a proper CLI, which comes with a help command and flags for creating a changelog.

Seniatical avatar Jan 24 '22 20:01 Seniatical

Example Use of CLI

image

Seniatical avatar Jan 25 '22 20:01 Seniatical

Thanks for this feature @Seniatical ! Having a proper CLI manager is definitely useful when we grow the tool to have diverging functionalities. For the moment, however, since generating in-project changelogs is the only featureset, doculog should be the default execution command - I don't want users to have to remember another flag in order to get the tool to run. I'll leave this open for a little bit while I think about the best approach though, as this might be useful for some other features. For example, maybe a --overwrite flag which ignores an existing changelog and generates from scratch?

TTitcombe avatar Jan 26 '22 19:01 TTitcombe

I don't want users to have to remember another flag in order to get the tool to run

This isn't an actual issue as I already left the "no arg" option empty, so getting it execute instantly isn't hard to implement

Seniatical avatar Jan 26 '22 20:01 Seniatical

--overwrite flag which ignores an existing changelog and generates from scratch?

👍

Seniatical avatar Jan 26 '22 20:01 Seniatical

Commented out CL flag, since there's no use for it as of now, but added the overwrite flag which deletes the CHANGELOG.md in the current dir allowing a fresh one to be generated

Seniatical avatar Jan 26 '22 20:01 Seniatical

Done as requested from above, added path flag to modify which directory user wants to generate changelog for

Seniatical avatar Feb 02 '22 11:02 Seniatical

is this still being worked on?

Assassin-1234 avatar Jul 11 '22 17:07 Assassin-1234

🤷

Seniatical avatar Jul 22 '22 21:07 Seniatical