Skip to content

Rikka Prompt Builder simplifies LLM-project communication by generating structured prompts with project directories/files, easing context input and aiding LLM understanding.

Notifications You must be signed in to change notification settings

yejue/rikka-prompt-builder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rikka Prompt Builder 🛠️

GitHub release License

一个帮助你快速构建包含项目文件与目录结构提示词的工具,让大语言模型(LLM)更好地理解你的项目上下文,简化与LLM的技术交流流程。

Rikka Prompt Builder 运行预览 Rikka Prompt Builder 运行界面预览

✨ 功能说明

  1. 📂 项目载入与目录树浏览
    可选择本地文件夹作为项目根目录,自动加载一级目录树;支持双击节点深入打开下一层目录(懒加载模式,提升性能),操作方式与常规文件管理器一致。

  2. 📄 文件内容预览与上下文添加

    • 点击文件节点可直接预览文本文件内容(支持UTF-8、GBK等多种编码),非文本文件会显示类型信息。
    • 右键点击文件/文件夹节点,可将其添加到提问上下文:
      • 文件夹:自动生成并添加一级目录结构(包含子文件/子文件夹列表)。
      • 文本文件:读取文件内容并按 file: {路径}\n{内容} 格式添加。
  3. 🔧 提示词生成与复制
    提供可隐藏的提示词实时预览区域,自动整合「自定义提示词」「添加的上下文」「用户问题」生成完整提示词;支持一键复制,直接粘贴到任意LLM对话窗口使用。

🚀 快速开始

方式1:从源码运行

  1. 克隆仓库

    git clone https://github.com/yejue/rikka-prompt-builder.git
    cd rikka-prompt-builder
  2. 安装依赖

    pip install -r requirements.txt
  3. 启动应用

    python run.py

方式2:从Release下载可执行文件

  1. 访问项目 Release 页面,下载对应系统的 exe 文件。
  2. 直接双击运行(无需安装依赖,适合非开发用户)。

🌟 版本特性(v0.1.0)

专注解决两个核心痛点:

  1. 解决LLM难以直接识别本地项目目录结构的问题,自动生成规范的目录树描述。
  2. 减少手动复制粘贴文件内容到提示词的重复工作,通过可视化操作快速构建上下文。

📅 未来规划

  • 内容超限处理:当上下文内容超出一定长度时,自动生成历史梗概或关键信息摘要。
  • 多轮对话辅助:支持基于历史对话记录,智能补充上下文,减少重复输入。
  • API直连:直接集成主流LLM API,无需复制到外部窗口,实现一站式提问。
  • 更多功能请关注 项目GitHub 或参与讨论。

🤝 贡献

欢迎提交issue和pull request,一起完善这个工具!

📄 许可证

本项目采用 MIT 许可证。

About

Rikka Prompt Builder simplifies LLM-project communication by generating structured prompts with project directories/files, easing context input and aiding LLM understanding.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages