开源项目Ghostwriter的使用与配置教程

开源项目Ghostwriter的使用与配置教程

ghostwriter Use the reMarkable2 as an interface to vision-LLMs (ChatGPT, Claude, Gemini). Ghost in the machine! 项目地址: https://gitcode.com/gh_mirrors/ghostwr/ghostwriter

1. 项目的目录结构及介绍

Ghostwriter项目的目录结构如下：

• src/: 源代码目录，包含了项目的主要逻辑。
• docs/: 文档目录，存放项目相关的文档。
• evaluation_results/: 评估结果目录，用于存放项目运行后的评估数据。
• evaluations/: 评估脚本目录，包含了项目评估的相关脚本。
• prompts/: 提示词目录，存放与项目交互的提示信息。
• tmp/: 临时文件目录，用于存放项目运行过程中产生的临时文件。
• utils/: 工具模块目录，包含了项目所需的工具函数。
• .cargo/: Cargo配置目录，用于存放Rust项目的配置文件。
• .github/: GitHub配置目录，包含了GitHub Actions的配置文件。
• Cargo.lock: Cargo依赖锁定文件，记录了项目依赖的具体版本。
• Cargo.toml: Cargo配置文件，定义了项目的元数据和依赖。
• LICENSE: 项目许可证文件，本项目采用MIT协议。
• README.md: 项目自述文件，介绍了项目的基本信息和使用方法。
• build.sh: 构建脚本，用于构建项目的可执行文件。
• run_eval.sh: 评估运行脚本，用于执行项目评估。

2. 项目的启动文件介绍

项目的启动文件为ghostwriter，该可执行文件是项目的入口点。在Remarkable设备上，你需要通过SSH连接到设备，然后运行该文件来启动项目。

启动命令如下：

./ghostwriter

你也可以指定模型参数来运行不同的模型，例如：

./ghostwriter --model gpt-4o-mini

3. 项目的配置文件介绍

项目的配置主要通过环境变量来完成。你需要在Remarkable的~/.bashrc文件中设置相关API密钥，如下所示：

export OPENAI_API_KEY=your-key-here
export ANTHROPIC_API_KEY=your-key-here
export GOOGLE_API_KEY=your-key-here

此外，项目还可能使用到Cargo.toml文件进行Rust项目依赖的配置，以及.github/workflows目录下的GitHub Actions工作流配置文件，用于自动化构建和发布等操作。

以上就是Ghostwriter开源项目的目录结构、启动文件和配置文件的详细介绍。希望对您使用和配置该项目有所帮助。

ghostwriter Use the reMarkable2 as an interface to vision-LLMs (ChatGPT, Claude, Gemini). Ghost in the machine! 项目地址: https://gitcode.com/gh_mirrors/ghostwr/ghostwriter