Sign inSign up

sethblack/black-seo-analyzer

By sethblack

•Updated over 1 year ago

A professional command-line tool for comprehensive SEO analysis.

Image
Developer tools
0

1.9K

sethblack/black-seo-analyzer repository overview

⁠Docker Usage for Black SEO Analyzer

This document explains how to use the Docker image for Black SEO Analyzer. For more comprehensive documentation on Black SEO Analyzer visit the GitHub page at github.com/sethblack/black-seo-analyzer⁠.

When run without a license you're limited in the number of pages you can crawl, but no other functionality is restricted. To purchase a license and unlock unlimited analysis power, visit Black SEO Analyzer product page⁠.

⁠Running Black SEO Analyzer with Docker

The Docker image is configured to make running Black SEO Analyzer as simple as possible. The basic command structure is:

docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer [OPTIONS]

Where:

  • --rm removes the container after it exits
  • -v "$(pwd)/output:/data" mounts the output directory from your current location to the /data directory in the container
  • [OPTIONS] are the command-line options for Black SEO Analyzer

⁠Examples

⁠Basic Website Analysis
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --output-type html-folder \
  --output-file /data/report

This will analyze the website at https://example.com⁠ and generate an HTML report in the output/report directory on your host machine.

⁠Analyzing a Single-Page Application (SPA)
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --spa \
  --output-type html-folder \
  --output-file /data/spa-report
⁠Analyzing a Sitemap
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com/sitemap.xml \
  --is-sitemap \
  --output-type json \
  --output-file /data/sitemap-report.json
⁠Generating Different Output Formats
# JSON output
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --output-type json \
  --output-file /data/report.json

# CSV output
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --output-type csv \
  --output-file /data/report.csv

# XML output
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --output-type xml \
  --output-file /data/report.xml
⁠Adjusting Crawl Settings
# Increase concurrent requests for faster crawling
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --concurrent-requests 30 \
  --output-type html-folder \
  --output-file /data/report

# Increase rate limit for slower crawling (more gentle on the server)
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --rate-limit 100 \
  --output-type html-folder \
  --output-file /data/report
⁠Using a Different Language
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --locale es \
  --output-type html-folder \
  --output-file /data/report-es

⁠Accessing Output Files

The output files will be available in the directory you mounted to /data in the container. For example, if you used -v "$(pwd)/output:/data", the files will be in the output directory relative to where you ran the Docker command.

⁠Advanced Usage

⁠Using Anthropic Claude for SEO Analysis

If you have an Anthropic API key, you can enable the Claude AI analyzer:

docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --use-anthropic-analyzer \
  --anthropic-api-key your_api_key_here \
  --output-type html-folder \
  --output-file /data/ai-report
⁠Setting a Custom User-Agent
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --user-agent "MyCustomBot/1.0" \
  --output-type html-folder \
  --output-file /data/report
⁠Limiting the Number of Pages
docker run --rm -v "$(pwd)/output:/data" black-seo-analyzer \
  --url-to-begin-crawl https://example.com \
  --max-pages 10 \
  --output-type html-folder \
  --output-file /data/report

⁠Troubleshooting

⁠Container Crashes

If the container crashes, you can run it with the -it flag to see the error messages:

docker run --rm -it -v "$(pwd)/output:/data" black-seo-analyzer [OPTIONS]
⁠Memory Issues

If you're analyzing a large website and encounter memory issues, you can allocate more memory to the Docker container:

docker run --rm -m 4g -v "$(pwd)/output:/data" black-seo-analyzer [OPTIONS]

This allocates 4GB of memory to the container.

It's also recommended to use the json-files output type to save memory, as page output is celared after each page analysis in json-files mode.

Tag summary

Content type

Image

Digest

sha256:017d23422…

Size

37.2 MB

Last updated

over 1 year ago

docker pull sethblack/black-seo-analyzer