Menu
Extract OpenGraph, Twitter Cards, and metadata from URLs or HTML, with dual extraction modes and social diagnostics for validator workflows.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Triggered when user asks to add structured logging, set up error tracking, implement monitoring, or configure observability. Automatically delegates to the logging-specialist agent.
Triggered when user asks to implement data validation, create validation schemas, add input validation, or ensure type-safe validation. Automatically delegates to the validation-specialist agent.
Triggered when user asks to design architecture, plan system structure, or make architectural decisions. Automatically delegates to the architect agent.
Triggered when user asks to audit code quality, assess maintainability, or review overall code quality. Automatically delegates to the quality-auditor agent.
Triggered when user asks to design APIs, create API specifications, or plan API endpoints. Automatically delegates to the api-designer agent.
Triggered when user asks to design database schemas, plan data models, or optimize database structure. Automatically delegates to the database-designer agent.
| name | ogie |
| description | Extract OpenGraph, Twitter Cards, and metadata from URLs or HTML, with dual extraction modes and social diagnostics for validator workflows. |
| license | MIT |
| metadata | {"author":"dobroslavradosavljevic","version":"1.1.0"} |
Use this skill when helping users extract metadata from webpages, build link previews, create SEO tools, parse OpenGraph/Twitter Card data, or run social metadata validation audits.
import { extract } from "ogie";
const result = await extract("https://github.com");
if (result.success) {
console.log(result.data.og.title);
console.log(result.data.og.description);
console.log(result.data.og.images[0]?.url);
}
extract(url, options?)Fetch and extract metadata from a URL.
import { extract } from "ogie";
const result = await extract("https://example.com", {
timeout: 10000,
maxRedirects: 5,
userAgent: "MyBot/1.0",
fetchOEmbed: true,
convertCharset: true,
});
if (result.success) {
console.log(result.data.og.title);
console.log(result.data.twitter.card);
console.log(result.data.basic.favicon);
}
extractFromHtml(html, options?)Extract metadata from an HTML string without network requests.
import { extractFromHtml } from "ogie";
const html = `
<html>
<head>
<meta property="og:title" content="My Page">
<meta property="og:image" content="/images/hero.jpg">
</head>
</html>
`;
const result = extractFromHtml(html, {
baseUrl: "https://example.com", // Required for relative URLs
});
extractWithDiagnostics(url, options?)Fetch metadata and return social diagnostics (valid, invalid, missing, warnings).
import { extractWithDiagnostics } from "ogie";
const result = await extractWithDiagnostics("https://example.com", {
mode: "platform-valid",
});
if (result.success) {
console.log(result.data.og.title);
console.log(result.diagnostics.summary);
}
extractFromHtmlWithDiagnostics(html, options?)Parse HTML and return metadata with social diagnostics.
import { extractFromHtmlWithDiagnostics } from "ogie";
const result = extractFromHtmlWithDiagnostics(html, {
baseUrl: "https://example.com",
mode: "platform-valid",
});
extractBulk(urls, options?)Extract metadata from multiple URLs with rate limiting.
import { extractBulk } from "ogie";
const result = await extractBulk(
["https://github.com", "https://twitter.com", "https://youtube.com"],
{
concurrency: 10,
concurrencyPerDomain: 3,
minDelayPerDomain: 200,
onProgress: (p) => console.log(`${p.completed}/${p.total}`),
}
);
for (const item of result.results) {
if (item.result.success) {
console.log(`${item.url}: ${item.result.data.og.title}`);
}
}
createCache(options?)Create an LRU cache for extraction results.
import { extract, createCache } from "ogie";
const cache = createCache({
maxSize: 100,
ttl: 300_000, // 5 minutes
});
// First call fetches, second returns cached
await extract("https://github.com", { cache });
await extract("https://github.com", { cache }); // Instant
Ogie extracts from 13 sources:
| Property | Description |
|---|---|
data.og | OpenGraph (title, images, etc.) |
data.twitter | Twitter Cards |
data.basic | HTML meta tags, favicon, title |
data.article | Article metadata (dates, author) |
data.video | Video metadata (actors, duration) |
data.music | Music metadata (album, duration) |
data.book | Book metadata (ISBN, authors) |
data.profile | Profile metadata (name, gender) |
data.jsonLd | JSON-LD structured data |
data.dublinCore | Dublin Core metadata |
data.appLinks | App Links for deep linking |
data.oEmbed | oEmbed data (if enabled) |
data.oEmbedDiscovery | Discovered oEmbed endpoints |
import { extract, isFetchError, isParseError } from "ogie";
const result = await extract(url);
if (!result.success) {
switch (result.error.code) {
case "INVALID_URL":
case "FETCH_ERROR":
case "TIMEOUT":
case "PARSE_ERROR":
case "NO_HTML":
case "REDIRECT_LIMIT":
console.error(result.error.message);
}
if (isFetchError(result.error)) {
console.log(`HTTP Status: ${result.error.statusCode}`);
}
}
| Option | Type | Default | Description |
|---|---|---|---|
timeout | number | 10000 | Request timeout in ms |
maxRedirects | number | 5 | Max redirects to follow |
userAgent | string | ogie/2.0 | Custom User-Agent string |
headers | Record<string, string> | {} | Custom HTTP headers |
baseUrl | string | — | Base URL for resolving relative paths |
mode | "best-effort" | "platform-valid" | "best-effort" | Extraction mode behavior |
onlyOpenGraph | boolean | false | Legacy: skip OG fallback parsing only |
allowPrivateUrls | boolean | false | Allow localhost/private IPs |
fetchOEmbed | boolean | false | Fetch oEmbed endpoint |
convertCharset | boolean | false | Auto charset detection |
cache | MetadataCache | false | — | Cache instance |
bypassCache | boolean | false | Force fresh fetch |
| Option | Type | Default | Description |
|---|---|---|---|
concurrency | number | 10 | Max parallel requests globally |
concurrencyPerDomain | number | 3 | Max parallel per domain |
minDelayPerDomain | number | 200 | Min ms between domain requests |
requestsPerMinute | number | 600 | Global rate limit |
timeout | number | 30000 | Timeout per request |
continueOnError | boolean | true | Continue on failures |
onProgress | function | — | Progress callback |
extractOptions | object | — | Options passed to each extract |
Ogie includes built-in protections:
// Allow private URLs for local development
await extract("http://localhost:3000", {
allowPrivateUrls: true,
});
mode: "best-effort" when you want maximum metadata coverage for downstream processing (summaries, indexing, enrichment).mode: "platform-valid" when you want only OG/Twitter values that pass strict social validation filters.extractWithDiagnostics or extractFromHtmlWithDiagnostics when you need validator-style reporting (valid, invalid, missing, warnings).const result = await extract(url);
if (result.success) {
const preview = {
title: result.data.og.title || result.data.basic.title,
description: result.data.og.description || result.data.basic.description,
image: result.data.og.images[0]?.url,
siteName: result.data.og.siteName,
favicon: result.data.basic.favicon,
};
}
import { extractWithDiagnostics } from "ogie";
const result = await extractWithDiagnostics(url, {
mode: "platform-valid",
});
if (result.success) {
console.log(result.diagnostics.missingRequiredFields);
console.log(result.diagnostics.invalidFields);
console.log(result.diagnostics.warnings);
}
const urls = ["https://a.com", "https://b.com", "https://c.com"];
const result = await extractBulk(urls, {
concurrency: 5,
onProgress: (p) => console.log(`${p.succeeded}/${p.total} done`),
});
console.log(`Success rate: ${result.stats.succeeded}/${result.stats.total}`);