ai-renamer 项目使用教程

ai-renamer 项目使用教程

ai-renamer A Node.js CLI that uses Ollama and LM Studio models (Llava, Gemma, Llama etc.) to intelligently rename files by their contents 项目地址: https://gitcode.com/gh_mirrors/ai/ai-renamer

1. 项目目录结构及介绍

ai-renamer 是一个基于 Node.js 的命令行工具，用于根据文件内容智能重命名文件。以下是项目的目录结构及其简要介绍：

ai-renamer/
├── .gitignore          # 忽略文件列表
├── license             # 开源许可证文件
├── package-lock.json   # 包版本锁定文件
├── package.json        # 包配置文件
├── readme.md           # 项目说明文件
├── src/                # 源代码目录
│   └── ...             # 源代码文件
└── ...                 # 其他可能的文件和目录

• .gitignore: 指定 Git 忽略的文件和目录。
• license: 项目使用的开源许可证信息，本项目采用 GPL-3.0 许可。
• package-lock.json: 记录项目的依赖项及其精确版本，用于确保安装的一致性。
• package.json: 包的配置文件，包括项目名称、版本、描述、依赖等。
• readme.md: 项目说明文件，包含项目简介、使用方法和贡献指南。
• src/: 源代码目录，包含项目的主要逻辑和功能实现。

2. 项目的启动文件介绍

ai-renamer 的启动主要通过命令行进行，以下是一些基本的命令行使用方法：

• 使用 npx 运行：

  npx ai-renamer /path
  

• 全局安装后使用：

  npm install -g ai-renamer
  ai-renamer /path
  

ai-renamer 支持多种参数，以下是一些常用的参数：

• -h, --help: 显示帮助信息。
• --version: 显示版本号。
• -p, --provider: 设置服务提供者（如 ollama, openai, lm-studio）。
• -a, --api-key: 如果使用 openai 作为提供者，需要设置 API 密钥。
• -u, --base-url: 设置 API 的基础 URL。
• -m, --model: 设置要使用的模型。
• -f, --frames: 设置从视频中提取的最大帧数。
• -c, --case: 设置文件名的样式。
• -x, --chars: 设置新文件名的最大字符数。
• -l, --language: 设置输出语言。
• -s, --include-subdirectories: 是否包括子目录中的文件。
• -r, --custom-prompt: 添加自定义提示给 LLM。

3. 项目的配置文件介绍

ai-renamer 使用一个配置文件来保存用户的参数设置，配置文件位于用户的家目录下，文件名为 ai-renamer.json。当用户通过命令行设置参数时，这些参数的值会被保存到该配置文件中，以便下次使用时无需重新输入。

配置文件的内容是一个 JSON 对象，包含所有可配置的参数及其值。用户可以直接编辑该文件来修改配置，或者在命令行中使用参数来更新配置。

例如，以下是一个配置文件的示例内容：

{
  "provider": "ollama",
  "model": "llava:13b",
  "base-url": "http://127.0.0.1:11434",
  "frames": 5,
  "case": "camelCase",
  "chars": 25,
  "language": "English",
  "include-subdirectories": "true",
  "custom-prompt": "Only describe the background"
}

以上就是 ai-renamer 项目的基本使用教程。如果您有更多问题或需要进一步的指导，请查阅官方文档或在 GitHub 上创建一个 issue。

ai-renamer A Node.js CLI that uses Ollama and LM Studio models (Llava, Gemma, Llama etc.) to intelligently rename files by their contents 项目地址: https://gitcode.com/gh_mirrors/ai/ai-renamer