---

Installation

$3

``bash
npm install -g waybackurls
`

$3

`bash
npm install waybackurls
`

Usage

$3

Fetch URLs and display to stdout:
`bash
waybackurls -d example.com
`

Save URLs to a file:
`bash
waybackurls -d example.com -o results.txt
`

Legacy syntax (still supported):
`bash
waybackurls example.com
`

$3

Import and use in your JavaScript code:

`javascript
const { fetchWaybackUrls } = require('waybackurls');

// Basic usage
(async () => {
try {
const urls = await fetchWaybackUrls('example.com');
console.log(Found ${urls.length} URLs:);
urls.forEach(url => console.log(url));
} catch (error) {
console.error('Error:', error.message);
}
})();
`

With options:
`javascript
const { fetchWaybackUrls } = require('waybackurls');

(async () => {
const urls = await fetchWaybackUrls('example.com', {
matchPrefix: true, // Match *.example.com (default: true)
collapse: 'urlkey' // Deduplication strategy (default: 'urlkey')
});

// Process URLs
const uniqueDomains = new Set(urls.map(url => new URL(url).hostname));
console.log('Unique subdomains found:', Array.from(uniqueDomains));
})();
`

API

$3

Fetches historical URLs for a domain from the Wayback Machine.

Parameters:
- domain (string, required): The domain to fetch URLs for (e.g., 'example.com')
- options (object, optional):
- matchPrefix (boolean): Match URLs with domain as prefix using *.domain (default: true)
- collapse (string): CDX collapse strategy for deduplication (default: 'urlkey')

Returns: Promise - Array of historical URLs

Throws: Error if domain is invalid or API request fails

CLI Options

`
Usage: waybackurls -d [-o ]

Options:
-d, --domain Domain to fetch URLs for (required)
-o, --output Output file (optional, defaults to stdout)
``

How It Works

This tool queries the Wayback Machine CDX API to retrieve all historical URLs archived for a given domain. The CDX (Capture Index) API provides a searchable index of web archives.

License

This project is licensed under the MIT License.