DEV Community

Discussion on: I Bet You Don't Keep A Developer Journal: 3 Reasons You Should

 
davidsgbr profile image
David SG

Sure, I understand your point, you have something that is already working. So let me try to point some benefits.

The aux4 learning curve is low if you are already familiar with JSON. I know it's not your case, but for another person who is not familiar with bash scripts, they can easily write their scripts but just following the structure.
You also can organize in whatever structure makes more sense to you use that. e.g:

aux4 my-project-a delete-kafka-topics /* it can delete all the kafka topics related to your project */

aux4 my-project-b s3 upload-configuration /* copy a file from your local to a specific bucket/path related to your project */
Enter fullscreen mode Exit fullscreen mode

You can share the script with your co-workers, you can create a package for each project, for example, and they can install it. It's great because it's common to have people in the team not familiar with bash, so they can just become users from what you created.

aux4 aux4 install my-project-a.json
Enter fullscreen mode Exit fullscreen mode

Instead of adding a lot of comments to your scripts to remember what are they doing, aux4 structure already allows you to document the parameters and commands, and it generates documentation in runtime, listing the sub-commands in each section, and also describing the parameters.
When you share it, you don't need to explain to the other people how to use that, they will know by just typing aux4.

I would challenge you to migrate two or three commands you have in your script to aux4 and see how you like, I am pretty sure you will end up migrating everything there in the end. It's addictive :)

Thread Thread
 
omril321 profile image
Omri Lavi

Thanks for the explanation! I understand it better now. Next time I'll need to write many scripts to a shared project, I'll remember aux4. Well done David! :)

Thread Thread
 
davidsgbr profile image
David SG

Thank you!