@lobehub/seo-cli
v1.7.0TypeScript
Lobe seo is a CLI tool that automate generation seo content for mdx
25.9K/weekUpdated 1 months agoMITUnpacked: 69.5 KB
Published by LobeHub
npm install @lobehub/seo-cli
Lobe SEO
Lobe SEO 是一款使用 ChatGPT 自动化 mdx 的 SEO Matter 的流程工具
English ・ 简体中文 ・ Changelog · [Report Bug][issues-url] · [Request Feature][issues-url]
[![][npm-release-shield]][npm-release-link]
[![][github-releasedate-shield]][github-releasedate-link]
[![][github-action-test-shield]][github-action-test-link]
[![][github-action-release-shield]][github-action-release-link]
[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]
文档目录
#### TOC
- ✨ 特性
- 📦 安装
- 🤯 使用
- 配置
- 环境变量
- 🔍 配置
- 运行
- ⌨️ 本地开发
- 🤝 参与贡献
- 🔗 链接
- More Products
- Credits
####
✨ 特性
- [x] 🤖 利用 ChatGPT 实现 Seo Matter 自动化
- [x] ♻️ 支持 seo 增量更新，按照缺失 seo 信息自动新增内容
- [x] 🛠️ 支持自定义 OpenAI 模型、API 代理、temperature
- [x] 📝 支持 Markdown Mdx seo 自动化
[![][back-to-top]](#readme-top)
📦 安装
要安装 Lobe seo，请运行以下命令：
``bash`
npm install -g @lobehub/seo-cli
> \[!IMPORTANT]\
> 请确保环境中 Node.js 版本 >= 18
[![][back-to-top]](#readme-top)
🤯 使用
要初始化配置 Lobe i8n，请运行以下命令：
`shell`
$ lobe-seo -o # 或使用完整标志 --option
> \[!IMPORTANT]\
> 要使用 AI 自动生成，需要在设置中填写 OpenAI 令牌
`shell翻译 Locale 文件
$ lobe-seo
指定配置文件
$ lobe-seo -c './custom-config.js' # or use the full flag --config
`
$3
可以按照 cosmiconfig 格式任选配置方式
-
中的 seo 属性
- 以 JSON 或 YAML 格式的 .seorc 文件
- .seorc.json、.seorc.yaml、.seorc.yml、.seorc.js、.seorc.cjs 文件> \[!TIP]
>
> 本项目提供了
defineConfig 安全定义方法可以从 @lobehub/seo-cli 中导入
$3
本项目提供了一些额外的配置项，使用环境变量进行设置：
| 环境变量 | 类型 | 描述 | 示例 |
| ------------------ | ---- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
OPENAI_API_KEY | 必选 | 这是你在 OpenAI 账户页面申请的 API 密钥 | sk-xxxxxx...xxxxxx |
| OPENAI_PROXY_URL | 可选 | 如果你手动配置了 OpenAI 接口代理，可以使用此配置项来覆盖默认的 OpenAI API 请求基础 URL | https://api.chatanywhere.cn/v1
默认值:
|[![][back-to-top]](#readme-top)
🔍 配置
| 属性名称 | 必填 | 类型 | 默认值 | 描述 |
| -------------- | ---- | -------------- | --------------- | ---------------------------- |
| entry |
* | string | - | 入口文件或文件夹 |
| entryExtension | | string | .mdx | 入口文件扩展名 |
| groupKey | | string | - | 为 Seo Matter 设置 Gorup key |
| tagStringify | | boolean | false | 将 tags 字符串化 |
| modelName | | string | gpt-3.5-turbo | 使用的模型 |
| temperature | | number | 0 | 使用的采样温度 |
| reference | | string | - | 自定义 SEO 规则 prompt |
| concurrency | | number | 5 | 同时并发的队列请求数量 |
| experimental | | experimental | {} | 实验性功能，见下文 |####
experimental| 属性名称 | 必填 | 类型 | 默认值 | 描述 |
| -------- | ---- | --------- | ------- | -------------------------------------------------------------- |
| jsonMode | |
| false | 开启 gpt 强制 json 输出提升稳定性 (只支持 23 年 11 月后新模型) |
#### 示例一
.seorc.jsjs
const { defineConfig } = require('@lobehub/seo-cli');module.exports = defineConfig({
entry: './docs/*/.mdx',
modelName: 'gpt-3.5-turbo-1106',
experimental: {
jsonMode: true,
},
});
`#### 示例二
json
{
"entry": "./docs/*/.mdx",
"experimental": {
"jsonMode": true
},
"modelName": "gpt-3.5-turbo-1106"
}
`#### 示例三
json
{
"...": "...",
"seo": {
"entry": "./docs/*/.mdx",
"modelName": "gpt-3.5-turbo-1106",
"experimental": {
"jsonMode": true
}
}
}
`[![][back-to-top]](#readme-top)
$3
使用
命令自动化生成 seo 文件：`shell
$ lobe-seo
`[![][back-to-top]](#readme-top)
⌨️ 本地开发
可以使用 Github Codespaces 进行在线开发：
[![][github-codespace-shield]][github-codespace-link]
或者，可以克隆存储库并运行以下命令进行本地开发：
[![][bun-shield]][bun-link]
bash
$ git clone https://github.com/lobehub/lobe-cli-toolbox.git
$ cd lobe-cli-toolbox
$ bun install
$ cd packages/lobe-seo
$ bun dev
``[![][back-to-top]](#readme-top)
🤝 参与贡献
我们非常欢迎各种形式的贡献。如果你对贡献代码感兴趣，可以查看我们的 GitHub [Issues][github-issues-link]，大展身手，向我们展示你的奇思妙想。
[![][pr-welcome-shield]][pr-welcome-link]
[![][github-contrib-shield]][github-contrib-link]
[![][back-to-top]](#readme-top)
🔗 链接
$3
- [🤖 Lobe Chat][lobe-chat] - An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application.
- [🤯 Lobe Theme][lobe-theme] - The modern theme for stable diffusion webui, exquisite interface design, highly customizable UI, and efficiency boosting features.
$3
- langchainjs -
[![][back-to-top]](#readme-top)
---
#### 📝 License
Copyright © 2023 [LobeHub][profile-link].
This project is MIT licensed.
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
[bun-link]: https://bun.sh
[bun-shield]: https://img.shields.io/badge/-speedup%20with%20bun-black?logo=bun&style=for-the-badge
[github-action-release-link]: https://github.com/lobehub/lobe-cli-toolbox/actions/workflows/release.yml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-cli-toolbox/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/lobehub/lobe-cli-toolbox/actions/workflows/test.yml
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-cli-toolbox/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-codespace-link]: https://codespaces.new/lobehub/lobe-cli-toolbox
[github-codespace-shield]: https://github.com/codespaces/badge.svg
[github-contrib-link]: https://github.com/lobehub/lobe-cli-toolbox/graphs/contributors
[github-contrib-shield]: https://contrib.rocks/image?repo=lobehub%2Flobe-cli-toolbox
[github-contributors-link]: https://github.com/lobehub/lobe-cli-toolbox/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-cli-toolbox?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/lobehub/lobe-cli-toolbox/network/members
[github-forks-shield]: https://img.shields.io/github/forks/lobehub/lobe-cli-toolbox?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/lobehub/lobe-cli-toolbox/issues
[github-issues-shield]: https://img.shields.io/github/issues/lobehub/lobe-cli-toolbox?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/lobehub/lobe-cli-toolbox/blob/master/LICENSE
[github-license-shield]: https://img.shields.io/github/license/lobehub/lobe-cli-toolbox?color=white&labelColor=black&style=flat-square
[github-releasedate-link]: https://github.com/lobehub/lobe-cli-toolbox/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/lobehub/lobe-cli-toolbox?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/lobehub/lobe-cli-toolbox/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/lobehub/lobe-cli-toolbox?color=ffcb47&labelColor=black&style=flat-square
[issues-url]: https://github.com/canisminor1990/lobe-commit/issues/new/choose
[lobe-chat]: https://github.com/lobehub/lobe-chat
[lobe-theme]: https://github.com/lobehub/sd-webui-lobe-theme
[npm-release-link]: https://www.npmjs.com/package/@lobehub/seo-cli
[npm-release-shield]: https://img.shields.io/npm/v/@lobehub/seo-cli?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square
[pr-welcome-link]: https://github.com/lobehub/lobe-cli-toolbox/pulls
[pr-welcome-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
[profile-link]: https://github.com/lobehub