GUI Documentation - bseoa | Step-by-Step Examples

Getting Started with GUI

When you launch the GUI application, you'll see a dark-themed window with:

Output area (top): Displays results, messages, and crawl progress with color-coded output
Input field (bottom): Type commands here with smart autocomplete
Submit button: Click or press Enter to execute commands

Key Features

Command History: Use Up/Down arrow keys to navigate previous commands
Auto-completion: Press Tab to complete commands as you type
Native Dialogs: File and folder pickers for easy path selection
Real-time Feedback: Color-coded output (errors in red, success in green, warnings in yellow)
Configuration Management: Save and load project-specific settings

Example Workflows

Example 1: Simple Website Audit

Perfect for quick SEO health checks

> set url https://mywebsite.com
URL set to: https://mywebsite.com

> set output-dir
[Folder browser opens - select a directory]
Output directory set to: C:\Reports\MyWebsite
Vector database path automatically set to: C:\Reports\MyWebsite\vector.db

> set output-type html-folder
Output type set to: html-folder

> crawl
Starting crawl of https://mywebsite.com...
[Real-time progress displayed]
Crawl completed: 47 pages analyzed
Report saved to: C:\Reports\MyWebsite\

Example 2: Quick Technical Check (50 Pages)

Fast analysis of site's technical SEO with page limit

> set url https://example.com
URL set to: https://example.com

> set max-pages 50
Max pages set to: 50

> set concurrent-requests 10
Concurrent requests set to: 10

> set output-type json
Output type set to: json

> crawl
Starting crawl (max 50 pages)...
[Progress updates]
Crawl completed: 50 pages analyzed

Example 3: Single-Page Application (SPA) Analysis

Analyze JavaScript-heavy websites with proper rendering

> set url https://spa-app.com
URL set to: https://spa-app.com

> set spa true
SPA mode enabled

> set output-type html-folder
Output type set to: html-folder

> crawl
Starting SPA crawl with JavaScript rendering...
[Progress updates]
SPA crawl completed: 23 pages analyzed

Example 4: Sitemap Analysis

Crawl all URLs from a sitemap.xml file

> set url https://example.com/sitemap.xml
URL set to: https://example.com/sitemap.xml

> set is-sitemap true
Sitemap mode enabled

> crawl
Parsing sitemap...
Found 142 URLs in sitemap
Starting crawl...
[Progress updates]
Sitemap crawl completed: 142 pages analyzed

Example 5: Competitive Analysis with AI

Analyze competitors with OpenAI-powered insights

> set url https://competitor.com
URL set to: https://competitor.com

> set openai-api-key sk-proj-xxxxxxxxxxxxx
OpenAI API key set
OpenAI analyzer automatically enabled

> set openai-model gpt-4o
OpenAI model set to: gpt-4o

> set openai-prompt Analyze this site's SEO strategy and content quality
OpenAI prompt set

> set max-pages 30
Max pages set to: 30

> crawl
Starting crawl with AI analysis...
[Crawl progress]
[AI analysis results displayed]
Crawl completed with AI insights

Example 6: Using Custom AI Prompts

Load prompts from files for consistent analysis

> set url https://example.com
URL set to: https://example.com

> set anthropic-api-key sk-ant-xxxxxxxxxxxxx
Anthropic API key set
Anthropic analyzer automatically enabled

> set anthropic-model claude-3-5-sonnet-20241022
Anthropic model set to: claude-3-5-sonnet-20241022

> set anthropic-prompt-file C:\Prompts\detailed-seo-audit.txt
Anthropic prompt loaded from file

> crawl
Starting crawl with Claude analysis...
[Progress and AI insights]

Example 7: Reviewing Past Crawls

Access and export previous crawl data from database

> list crawls
Crawl Database: C:\Reports\crawl.db

ID  | Session ID                           | URL                    | Start Time          | Pages
----|--------------------------------------|------------------------|---------------------|------
1   | abc123-def456-ghi789                 | https://site1.com      | 2026-02-10 14:30:00 | 127
2   | xyz789-uvw456-rst123                 | https://site2.com      | 2026-02-12 09:15:00 | 89
3   | mno345-pqr678-stu901                 | https://site3.com      | 2026-02-14 16:45:00 | 234

> export abc123-def456-ghi789 html-folder
Exporting crawl session: abc123-def456-ghi789
Output type: html-folder
Export completed: C:\Reports\site1-export\

Example 8: Configuration Management

Save and load project-specific settings

> show config
Current Configuration:
  url: https://example.com
  output-dir: C:\Reports
  output-type: html-folder
  concurrent-requests: 10
  rate-limit: 50
  max-pages: 100
  [... more settings ...]

> save my-project-config.json
[Save dialog opens]
Configuration saved to: C:\Configs\my-project-config.json

[Later session...]
> load my-project-config.json
[Open dialog opens]
Configuration loaded from: C:\Configs\my-project-config.json
All settings restored!

Example 9: Advanced Rate Limiting

Control crawl speed to avoid overwhelming servers

> set url https://slow-server.com
URL set to: https://slow-server.com

> set concurrent-requests 5
Concurrent requests set to: 5

> set rate-limit 200
Rate limit set to: 200ms between requests

> set max-pages 50
Max pages set to: 50

> crawl
Starting crawl with rate limiting...
[Slower, controlled progress]

Example 10: Multi-Provider AI Analysis

Use multiple AI providers for comprehensive insights

> set url https://example.com
URL set to: https://example.com

> set openai-api-key sk-proj-xxxxxxxxxxxxx
OpenAI API key set

> set anthropic-api-key sk-ant-xxxxxxxxxxxxx
Anthropic API key set

> set gemini-api-key xxxxxxxxxxxxx
Gemini API key set

> set max-pages 20
Max pages set to: 20

> crawl
Starting crawl with multiple AI analyzers...
[Analysis from OpenAI, Anthropic, and Gemini]
Multi-provider analysis completed

GUI Commands Reference

Essential Commands

help	Show all available commands
version	Display application version
clear	Clear output window
exit / quit	Close application

Configuration Commands

show config	Display all current settings
set <option> <value>	Set a configuration option
save [filename]	Save configuration to JSON file
load [filename]	Load configuration from JSON file

Crawling Commands

crawl [url]	Start crawling (uses configured URL if not provided)
list crawls	List all crawls in database
export <id> [type]	Export crawl from database

License Command

license [key]

Set or check license key status

Keyboard Shortcuts

Enter	Submit command
Tab	Accept auto-completion suggestion
Right Arrow	Accept suggestion (when cursor at end)
Up Arrow	Navigate to older command in history
Down Arrow	Navigate to newer command in history
Type anywhere	Auto-focuses input field (no need to click)

Tips and Best Practices

Use Auto-completion: Start typing a command and press Tab to complete it instantly
Save Configurations: Create project-specific config files for repeated analyses
Review Past Crawls: Use list crawls to see previous analyses and avoid duplicate work
Monitor Progress: GUI shows real-time updates with color-coded messages
Start Small: Test with max-pages 10 before running full crawls
Rate Limiting: Use rate-limit for shared or slow servers to avoid issues
AI Prompts: Save custom prompts to files for reusable analysis templates
Export Flexibility: Re-export past crawls in different formats without re-crawling
Folder Browser: Type set output-dir without a value to open the folder picker

← Back to Full Documentation