cliseo/README.md

Instant AI-Powered SEO Optimization CLI for Developers

<div style="margin-bottom: 16px;">
  <img src="https://cliseo.com/README%20Logo.png?v=2025" width="688px" style="border: none;">
</div>


[![Website](https://img.shields.io/website?url=https%3A%2F%2Fcliseo.com&up_message=cliseo.com&up_color=blue)](https://cliseo.com)
[![Documentation](https://img.shields.io/badge/docs-read-blue)](https://cliseo.com/docs/)
[![License: AGPL-3.0](https://img.shields.io/badge/license-AGPL%20V3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html)
[![npm version](https://img.shields.io/npm/v/cliseo.svg)](https://www.npmjs.com/package/cliseo)
[![GitHub stars](https://img.shields.io/github/stars/cliseo/cliseo.svg)](https://github.com/cliseo//cliseo/stargazers)
[![npm downloads](https://img.shields.io/npm/dt/cliseo.svg)](https://www.npmjs.com/package/cliseo)

#### SEO Optimization CLI for JavaScript/TypeScript Projects [(Demo Video)](https://youtu.be/JDOVvaOdMWk?si=1NJ6bwOx20F4z5di)

<img src="https://cliseo.com/Diff.png?v=2025" width="700px" style="border: none;">
 

Most developers know SEO matters, but it’s often overlooked or left until the end— especially in modern frontend frameworks. Cliseo makes technical SEO automatic and accessible by detecting your framework (React, Next.js, Angular soon) and injecting essential elements like meta tags, alt text, JSON-LD schema, sitemap.xml, and robots.txt.

The goal isn’t to guarantee search rankings, but to ensure your site meets baseline SEO standards and is fully crawlable by search engines. Cliseo helps bring your Google Lighthouse SEO score to 100, giving your content, keywords, and link-building efforts a strong technical foundation to build on.

## 🚀 Features

### Current Features
- 🔍 Deep scanning of React and Next.js projects
- 🛠️ Automatic SEO fixes for common issues
- 📁 SEO file generation (robots.txt, sitemap.xml)
- ⚡ Cross-platform support

### Coming Soon
- 🤖 AI-powered SEO analysis and optimization
- 📊 SEO performance tracking and metrics
- 🔄 GitHub integration with automated PR creation
- 📈 Google Search Console integration

## 📦 Installation

```bash
npm install -g cliseo
```

## 🎯 Quick Start

1. Scan your project for SEO issues:
```bash
cliseo scan
```

2. Apply optimizations:
```bash
cliseo optimize
```

## 🛠️ Commands

### `cliseo scan`
Performs an SEO audit of your project.

Options:
- `--verbose`: Show detailed output
- `--json`: Output results in JSON format

### `cliseo optimize`
Automatically applies SEO fixes to your codebase.

## 🤝 Contribute

We welcome contributions of all kinds to **cliseo** — whether it's fixing bugs, adding new features, improving performance, or even enhancing the documentation!

### How to Contribute

1. **Fork this repo** and clone your fork.
2. Create a new branch for your feature or fix:
   ```bash
   git checkout -b your-feature-name
   ```
3. Make your changes and commit them with clear messages.
4. Push to your fork:
   ```bash
   git push origin your-feature-name
   ```
5. Open a Pull Request to the `main` branch of this repo.

### Contribution Guidelines

- 📑 Keep your code clean and well-commented.
- 💡 If adding a new feature, include a brief description in the PR.
- 🪲 If fixing a bug, describe the issue and how your fix solves it.
- 🧪 Run any relevant tests (or add some if they don't exist!).
  - Tests for React and Next applications can be found in `./tests/run-tests.sh`
- ❌ Avoid making large unrelated changes in a single PR.

### Not Sure Where to Start?

Check out the [Issues](../../issues) tab for things marked with:

- `good first issue`
- `help wanted`

</div>