blackoutsecure/Blackout Secure Robots TXT Generator
Generate a standards-compliant robots.txt with automated crawler rules, sitemaps, and SEO.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| site_url | Base site URL (optional). Used to normalize relative sitemap_urls entries. | no | — |
| public_dir | Directory to write robots.txt. Defaults to dist. | no | dist |
| robots_output_dir | Override output directory for robots.txt (defaults to public_dir). | no | — |
| robots_filename | Filename for robots.txt (default robots.txt). | no | robots.txt |
| allow_autodetect | Auto-detect site_url/public_dir when not provided (CNAME or GitHub Pages). | no | true |
| robots_user_agent | robots.txt User-agent directive (default *). | no | * |
| robots_disallow | Comma-separated URL-path prefixes for Disallow directives (e.g., /admin/,/private/). | no | "" |
| robots_allow | Comma-separated URL-path prefixes for Allow directives. | no | "" |
| robots_crawl_delay | Crawl-delay directive in seconds. | no | "" |
| robots_comments | Include generator comments in robots.txt. | no | true |
| strict_validation | Fail the run when robots.txt validation errors are found. | no | true |
| sitemap_urls | Comma-separated sitemap URLs to reference in robots.txt. | no | — |
| include_sitemap | Include default sitemap URL in robots.txt (based on site_url + sitemap_filename). | no | true |
| sitemap_filename | Default sitemap filename when include_sitemap is true. | no | sitemap.xml |
| debug_show_robots | Debug: display generated robots.txt content. | no | false |
| upload_artifacts | Upload robots.txt as a GitHub Actions artifact. | no | true |
| artifact_name | Name of the artifact when upload_artifacts is enabled. | no | robots-file |
| artifact_retention_days | Number of days to retain the artifact (1-90). Leave empty for default. | no | — |
Outputs
| name | description |
|---|---|
| robots_path | Path to the generated robots.txt |