Introduction

Over the past 3 weeks, I worked on release 0.1 of my project. This project involves working with a chat API endpoint to create a command line tool that transfers files in a helpful way. I'm using it to create a tool that takes files and creates a README file that describes what they do. In fact, once I was done completing this tool, I used it to partially make the README tool that was used in this assignment. Here's a link to the repo and a demo video of how to use it:

https://github.com/mpa-LHutchinson/Auto-README

Before starting

Before using the tool, the user must provide their own API key. They can do this either by either creating a .env file in the project directory, or they can add it as an environment variable in their terminal.

Commands

Here is an overview of the commands:

node index.js

This will simply print out an introductory message for the user, suggesting them to run the command with the -h extension instead.

node index.js --h

This will display to the user all the available command line options.

node index.js example.js

This will prompt the AI to generate a README file which summarizes and explains how to use example.js. This new file will be named "generatedfile.md" by default and will appear in the project directory.

node index.js example1.js example2.js

This will prompt the AI to generate a README file which summarizes and explains how to use example1.js and example2.js, as if they are apart of the same program. This can be done on as many files as the user wants, as long as they exist. This new file will be named "generatedfile.md" by default and will appear in the project directory.

node index.js --v

This will tell the user what version of the project they are using. Right now, it is version 0.1

node index.js --m

This will tell the user the AI model that is being used.

node index.js example.js --o funny.md

This will prompt the AI to generate a README file which summarizes and explains how to use example.js. However, the --o extension lets the user name the generated README file. In this example, the user is naming the file "funny.md"

node index.js example.js --t

This will prompt the AI to generate a README file which summarizes and explains how to use example.js. With the --t extension, it will also show the user some information about the tokens used. This feature was actually implemented by my lab 2 partner.

Conclusion

This project was a lot of fun to work on, especially during the labs where I had the opportunity to work with someone else for improvement. Overall I am looking forward to developing this tool further and work on more open source projects.