@aurthle/seo-cli v1.4.3

Lobe SEO is a workflow tool that automates SEO Matter using ChatGPT.

English ・ 简体中文 ・ Changelog · Report Bug · Request Feature

TOC

• ✨ Features
• 📦 Installation
• 🤯 Usage
  • Configuration
  • Environment Variables
• 🔍 Configuration
  • Running
• ⌨️ Local Development
• 🤝 Contributing
• 🔗 Links
  • More Products
  • Credits

✨ Features

• 🤖 Automate SEO Matter using ChatGPT
• ♻️ Support incremental SEO updates, automatically adding content for missing SEO information
• 🛠️ Support custom OpenAI models, API proxies, temperature
• 📝 Support Markdown Mdx SEO automation

📦 Installation

To install Lobe SEO, run the following command:

npm install -g @lobehub/seo-cli

[!IMPORTANT]\ Make sure your environment has Node.js version >= 18

🤯 Usage

To initialize Lobe i8n configuration, run the following command:

$ lobe-seo -o # or use the full flag --option

[!IMPORTANT]\ To use AI auto-generation, you need to fill in the OpenAI token in the settings

# Translate Locale files
$ lobe-seo

# Specify a configuration file
$ lobe-seo -c './custom-config.js' # or use the full flag --config

Configuration

You can choose any configuration method in cosmiconfig format

• seo property in package.json
• .seorc file in JSON or YAML format
• .seorc.json, .seorc.yaml, .seorc.yml, .seorc.js, .seorc.cjs files

[!TIP]

This project provides a defineConfig secure definition method that can be imported from @lobehub/seo-cli

Environment Variables

Some additional configurations are provided in this project, set using environment variables:

🔍 Configuration

experimental

Example 1 .seorc.js

const { defineConfig } = require('@lobehub/seo-cli');

module.exports = defineConfig({
  entry: './docs/**/*.mdx',
  modelName: 'gpt-3.5-turbo-1106',
  experimental: {
    jsonMode: true,
  },
});

Example 2 .seorc.json

{
  "entry": "./docs/**/*.mdx",
  "experimental": {
    "jsonMode": true
  },
  "modelName": "gpt-3.5-turbo-1106"
}

Example 3 package.json

{
  "...": "...",
  "seo": {
    "entry": "./docs/**/*.mdx",
    "modelName": "gpt-3.5-turbo-1106",
    "experimental": {
      "jsonMode": true
    }
  }
}

Running

Automatically generate SEO files using the lobe-seo command:

$ lobe-seo

⌨️ Local Development

You can use Github Codespaces for online development:

Alternatively, you can clone the repository and run the following commands for local development:

$ git clone https://github.com/lobehub/lobe-cli-toolbox.git
$ cd lobe-cli-toolbox
$ bun install
$ cd packages/lobe-seo
$ bun dev

🤝 Contributing

We welcome contributions in all forms. If you are interested in contributing code, you can check out our GitHub Issues, showcase your creativity, and share your ideas with us.

🔗 Links

More Products

• 🤖 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 - The modern theme for stable diffusion webui, exquisite interface design, highly customizable UI, and efficiency boosting features.

Credits

• langchainjs - https://github.com/hwchase17/langchainjs

📝 License

Copyright © 2023 LobeHub. This project is licensed under MIT.