codeprompts

代码提示

命令行（和TUI）工具，用于使用车把模板从代码中创建LLM提示。

这是一个可以在Rust上进行刷新的项目，并且基于Code2Prompt，并具有一些我发现有用的其他功能。

• 为什么要提示？
• 终端用户界面
• 安装
  • 释放二进制
  • 从来源建造
• 用法
  • 争论
• 模板
• 用法指南

---

为什么要提示？

手动将代码和代码片段复制到LLMS有几个问题：

1. 您会失去格式和结构。对于使用Whitespace的Python之类的语言，代码的格式和结构对于LLM准确，全面地理解您的请求代码很重要。
2. 你失去背景。为了使LLM提供最佳响应，它需要您所有代码的上下文。这包括您的代码段的依赖项，其他用户定义的模块/对象以及其他范围变量和概念。
3. 您将失去及时的标准化：如果您使用LLMS执行重复的任务（例如文档代码），则必须确保您的文档样式指南在每个请求中都保持一致。
4. 行号！ ：在大型输入上，LLM倾向于为精确线提供代码更改，因此很难准确地固定在哪里应用/查看所提出的更改。行号有助于减轻这一点，以获得更好的代码出处。

为了充分利用LLM，提示必须是清晰，全面和一致的。代码如何提示解决这些问题：

1. 代码提示将确保保留代码的固有结构，以限制LLM所需的任何可能的误解或卑鄙的误解。
2. 理解代码所需的完整上下文是以标准化格式封闭的。这包括项目目录树和文件路径。
3. 通过使用车把模板，提示将是全面且一致的。如果将来更新您喜欢的样式指南和/或编码实践，则无需记住更新所有将来的手动输入提示。相反，只需一次更新目标车把模板即可。

终端用户界面

该项目还包括一个可选的TUI包装器，您可以在其中提供一个配置文件来覆盖各种标志，并在运行之前查看命令的结构。

安装

要下载并使用CodePrompts命令行工具，您有两个选择：您可以从源中下载版本二进制或编译。有关更详细的步骤，包括设置选项卡的完成，请参见“设置指南”。

释放二进制

要下载版本的二进制文件，请转到发行版并为操作系统下载二进制文件。

注意：为了使用TUI二进制，您必须将CLI二进制添加到您的路径上，并且要么：

• 重命名CLI释放codeprompt
• 更新命令的配置文件以运行CLI二进制文件

从来源建造

要从源构建，您需要安装git，生锈和货物（将用锈蚀安装）。

首先克隆存储库：

git clone [email protected]:seankim658/codeprompts.git

然后编译释放二进制：

 cd codeprompts/
cargo build --release

用法

可以在此处找到更多详细的用法指南。

争论

有关选项的更广泛的文档，请参见此处。代码提示命令行工具具有以下参数：

Create standardized LLM prompts from your code

Usage: codeprompt [OPTIONS] [PATH] [COMMAND]

Commands:
  completion  Generate shell completion scripts.
  help        Print this message or the help of the given subcommand(s)

Arguments:
  [PATH]  Path to project directory

Options:
      --include <INCLUDE>    Glob patterns to include
      --exclude <EXCLUDE>    Glob patterns to exclude
      --exclude-priority     Change pattern priority in case of conflict to prioritize the exclusion pattern
      --exclude-from-tree    Eclude files/folders from the source tree based on exclude patterns
      --gitignore            Don't respect .gitignore file
  -d, --diff-staged          Capture the git diff for staged changes only (equivalent to running `git diff --cached` or `git diff --staged`
  -u, --diff-unstaged        Capture the git diff for unstaged changes only (equivalent to running `git diff`)
      --no-tokens            Don't display approximate token count of the genrated prompt
  -c, --encoding <ENCODING>  Tokenizer to use for token count [default: cl100k]
  -o, --output <OUTPUT>      Redirect output to file
  -l, --no-line-numbers      Turn off line numbers in source code blocks
      --no-codeblock         Disable wrapping code inside markdown code blocks
      --relative-paths       Use relative paths instead of absolute paths, including parent directory
      --no-clipboard         Disable copying to clipboard
  -t, --template <TEMPLATE>  Optional path to Handlebars template
      --no-spinner           Whether to render the spinner
      --json                 Whether to print the output as JSON. Defaults to False
      --issue <ISSUE>        Fetch a specific Github issue for the repository
      --verbose              Run in verbose mode to investigate glob pattern matching
  -h, --help                 Print help (see more with '--help')
  -V, --version              Print version

模板

这些模板使用一种称为车把的简单模板语言。

可以从项目发布中下载预定义的模板。下载templates.zip 。

当前，随附的预定义模板是：

模板名称	描述
default_template.hbs	这是一个简单的默认模板，它将构建您的项目路径，源树和代码块。
documentation_template.hbs	文档模板为记录代码创建了一个提示。文档指南与Hive Lab指南和文档要求一致。
git_commit.hbs	用于创建简洁明了的git提交消息的模板。可以与diff-staged和diff-unstaged选项一起使用。
git_issues.hbs	基于GitHub问题实施更改的模板。
code_optimization.hbs	用于优化时间和空间复杂性代码的模板。