Genereadme v 版本

发布v0.1

对于我们在开源课程中的第一个作业，我们的任务是为利用 LLM 的 CLI 工具制作 0.1 版本。它可以是任何类型的工具，只要它满足一组要求即可：它必须使用 OpenAI 的聊天完成功能，并且必须通过命令行参数处理和转换文件。

基因自述文件

对于我的作业，我选择创建 Genereadme，这是一个 CLI 工具，可以为提供的源代码文件生成 README 文件。我选择做这个项目是因为编写自述文件不是我的强项之一，而且我也觉得这很麻烦。但考虑到文档的重要性，尤其是在大型项目中，开发过程中的这一步不容忽视。所以我想，为什么不做一些可以帮助我做到这一点的东西呢？

克莱布恩特拉 / 基因自述文件

GENEREADME 是一个命令行工具，它接收源代码文件并生成 README.md 文件，该文件利用 LLM 解释文件中的代码。

GENEREADME

GENEREADME 是一个命令行工具，它接收文件、处理它并生成一个 README 文件，其中包含文件内容的解释或文档。该工具利用 OpenAI 聊天完成来分析文件并生成内容。

用法

通过创建 .env 文件或通过 -a 或 --api-key 标志来提供有效的 API 密钥：

GROQ_API_KEY=API_KEY

or

genereadme -a API_KEY
genereadme --api-key API_KEY

安装依赖项：

npm install

使用现有示例文件运行该工具或开始使用您自己的：

genereadme <files>
genereadme examples/sum.js
genereadme examples/createUser.js examples/sum.js

注意：该工具接受任何文件，但只会为包含代码作为内容的文件提供适当的生成结果。
使用的文件可以放在任何地方，只要提供适当的路径即可。

标记选项

<表格> <标题> 标志 描述 用法 <正文> -v

flag	description	usage
-v --version	Displays the tool's name and the current version.	genereadme -v genereadme --version

--版本 显示工具的名称和当前版本。 <🎜>genereadme<🎜> -v<🎜><🎜>genereadme<🎜> --version

…

View on GitHub

Get started

Simply install the packages after cloning the repository

npm install

Run and generate!

genereadme examples/sum.js
genereadme examples/createUser.js
genereadme examples/sum.js examples/createUser.js
genereadme examples/sum.js examples/createUser.js --output sample.md

How it works

The user can pass any number of files in the command line using the command genereadme .... The contents of these files will be processed individually to generate their README documentation.
The generated READMEs will be saved as filename_README.md to prevent any naming collision when processing multiple files.

Arguments

• : The file to be processed and generate a README for.

Options

• -v or --version: Displays the tool's name and the current version.
• -h or --help: Displays the help message for the tool.
• -o or --output: Outputs the generated results into the specified output filename.
• -a or --api-key: Allows the user to use their own valid API key.
• -t or --temperature: Allows the user to set their preferred temperature for the chat completion.
• -tu or --token-usage: Shows the amount of tokens used for the prompt and the completion.

Examples

genereadme examples/createUser.js

export async function createUser(data) {
    const user = {
      Username: data.email,
      UserPoolId: process.env.AWS_COGNITO_POOL_ID,
      TemporaryPassword: data.temporaryPassword,
      UserAttributes: [
        {
          Name: "email",
          Value: data.email,
        },
        {
          Name: "name",
          Value: data.name,
        },
      ],
      MessageAction: MessageActionType.SUPPRESS,
      DesiredDeliveryMediums: [DeliveryMediumType.EMAIL],
    };

    const command = new AdminCreateUserCommand(user);
    try {
      const createRes = await cognitoClient.send(command);
      logger.info(`Created user: [${JSON.stringify(createRes)}]`);

      const addUserToGroupParams = {
        UserPoolId: process.env.AWS_COGNITO_POOL_ID,
        Username: data.email,
        GroupName: data.group,
      };

      const addUserToGroupCommand = new AdminAddUserToGroupCommand(addUserToGroupParams);
      const addRes = await cognitoClient.send(addUserToGroupCommand);
      logger.info(`Added user to group: [${JSON.stringify(addRes)}]`);
    } catch (error) {
      logger.error(`Error creating user: ${error}`);
      throw new Error("Error creating user.");
    }
  }

generated README for createUser.js

Conclusion

It is my first time working directly with LLMs by myself, so it definitely took some time prompt engineering to get a somewhat satisfying result. However, I do know that there are still a lot that can be improved on and I'm already getting ideas on what to do and what else I can add to this project!