​
generate-llmstxt

一个简单的NPX包，使用Firecrawl API生成LLMs.txt文件。此包会在您指定的输出目录中创建两个文件（默认为’public’文件夹）：

  • llms.txt：包含与LLM相关内容的摘要
  • llms-full.txt：包含完整的文本内容

​
使用方法

您可以使用NPX运行此包而无需安装。提供您的Firecrawl API密钥有两种方法：

​
1. 使用命令行参数

npx generate-llmstxt --api-key YOUR_FIRECRAWL_API_KEY

​
2. 使用环境变量

在项目根目录下创建一个.env文件并添加您的API密钥：

FIRECRAWL_API_KEY=your_api_key_here

然后不带—api-key选项运行以下命令：

npx generate-llmstxt

​
选项

  • -k, --api-key <key> (如果已在.env中设置则为可选)：您的Firecrawl API密钥
  • -u, --url <url> (可选)：要分析的URL（默认：https://example.com）
  • -m, --max-urls <number> (可选)：要分析的最大URL数量（默认：50）
  • -o, --output-dir <path> (可选)：输出目录路径（默认：‘public’）

​
示例

# 使用命令行参数和默认输出目录
npx generate-llmstxt -k your_api_key -u https://your-website.com -m 20

# 使用.env文件和默认输出目录
npx generate-llmstxt -u https://your-website.com -m 20

# 指定自定义输出目录
npx generate-llmstxt -k your_api_key -u https://your-website.com -o custom/path/to/output

# 使用.env文件和自定义输出目录
npx generate-llmstxt -u https://your-website.com -o content/llms

​
要求

  • Node.js 14或更高版本
  • 有效的Firecrawl API密钥（通过命令行或.env文件）

​
输出

该包将在您指定的输出目录中创建两个文件（默认为’public’）：

  1. llms.txt：包含与LLM相关内容的摘要
  2. llms-full.txt：包含完整的文本内容

​
许可证

MIT