https://github.com/dxheroes/cross-link-ai
Find linking opportunities between two sitemaps using AI
https://github.com/dxheroes/cross-link-ai
ai linkbuilding openai sitemap
Last synced: 3 months ago
JSON representation
Find linking opportunities between two sitemaps using AI
- Host: GitHub
- URL: https://github.com/dxheroes/cross-link-ai
- Owner: DXHeroes
- License: mit
- Created: 2024-09-16T18:54:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-06T15:56:27.000Z (3 months ago)
- Last Synced: 2025-07-06T16:40:34.491Z (3 months ago)
- Topics: ai, linkbuilding, openai, sitemap
- Language: TypeScript
- Homepage: https://github.com/DXHeroes/cross-link-ai
- Size: 48.8 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cross-link-ai
Find linking opportunities between two sitemaps using AI
This project is a CLI tool designed to find linking opportunities between websites using AI-powered content analysis.
## Features
- Fetch and parse sitemaps
- Extract main content from web pages
- Analyze content using AI to identify keywords and titles
- Uses `gpt-4o-mini` model from `ai` Vercel SDK
- Compare content across different websites to find linking opportunities
## Prerequisites
- Node.js (v20.15.0 or later)
- yarn or npm
- OpenAI API key (you can use [OpenAI API Playground](https://platform.openai.com/playground) to get one)
## Usage
To start the linking opportunities process, use the following command:
```
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY &&
npx cross-link-ai start -m [your-sitemap-url] -s [target-sitemap-url] -f [your-sitemap-filter] -g [target-sitemap-filter]
```
### Example
```bash
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY &&
npx cross-link-ai start -m https://dxheroes.io/sitemap.xml -s https://developerexperience.io/sitemap.xml --my-filter "/blog/" --sitemap-filter "articles/"
```
Replace `[your-sitemap-url]` with the URL of your sitemap and `[target-sitemap-url]` with the URL of the sitemap you want to compare against.
### Options
```bash
Usage: cross-link-ai start [options]
Start the intelligent linking opportunities process
Options:
-m, --my Your Sitemap URL
-s, --sitemap URL to the target sitemap file
-f, --my-filter Regex to filter paths for your sitemap
-g, --sitemap-filter Regex to filter paths for the other sitemap
-h, --help display help for command
```
## Scripts
- `yarn start`: Run the application
- `yarn build`: Build the project using webpack
- `yarn dev`: Run the application in watch mode
- `yarn test:watch`: Run tests in watch mode
- `yarn format`: Format code using Prettier
## Project Structure
- `src/`: Source code
- `main.ts`: Entry point of the application
- `start/`: Main logic for the linking opportunities process
- `helper.ts`: Utility functions
## Dependencies
Key dependencies include:
- `@ai-sdk/anthropic` and `@ai-sdk/openai`: AI SDKs for content analysis
- `cheerio`: HTML parsing
- `commander`: CLI interface
- `sitemap-links-ts`: Sitemap parsing
- `zod`: Schema validation
For a full list of dependencies, refer to the `package.json` file.
## Development
## Installation
1. Clone the repository:
```
git clone https://github.com/dxheroes/cross-link-ai
cd cross-link-ai
```
2. Install dependencies:
```
yarn install
# or
npm install
```
3. Create `.env` file with `OPENAI_API_KEY`. See `.env.example` for more info.
4. Start the development server:
```
yarn dev
# or
npm run dev
```
5. Format code before committing:
```
yarn format
# or
npm run format
```
## Building
To build the project for production:
```
yarn build
# or
npm run build
```
The output will be in the `dist/` directory.
## Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some Amazing Feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License.
## Author
Prokop Simek