hyperctl graph

hyperctl graph command

Overview

The hyperctl graph command is used to scrape website metadata. The HyperTemplates web scraper fetches Facebook Open Graph protocol, Twitter Card, and OEmbed metadata.

Usage

 1$ hyperctl graph -h
 2Fetch entity and page metadata from the HyperGraph™️.
 3
 4Usage:
 5        hyperctl graph <resource> [options] <href>
 6
 7Options:
 8        -f, --format   Output format for HyperGraph metadata. (default: json)
 9            --verbose  Enable verbose mode. (default: false)
10        -h, --help     Display help information.

Examples

The hyperctl graph document command works with YouTube, TikTok, Twitter (RIP) X, and wherever you get your websites.

 1$ hyperctl graph document https://www.youtube.com/watch?v=dQw4w9WgXcQ
 2{
 3        "author": {
 4                "favicon": "https://www.youtube.com/s/desktop/fc303b88/img/logos/favicon_144x144.png",
 5                "href": "https://www.youtube.com/",
 6                "name": "YouTube",
 7                "username": "@youtube.com"
 8        },
 9        "hypergraph": {
10                "author": "YouTube",
11                "cover": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
12                "description": "The official video for “Never Gonna Give You Up” by Rick Astley. Never: The Autobiography 📚 OUT NOW! Follow this link to get your copy and listen to Rick’s ...",
13                "favicon": "https://www.youtube.com/s/desktop/fc303b88/img/logos/favicon_144x144.png",
14                "href": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
15                "title": "Rick Astley - Never Gonna Give You Up (Official Music Video) - YouTube"
16        },
17        "oembed": {
18                "author_name": "Rick Astley",
19                "author_url": "https://www.youtube.com/@RickAstleyYT",
20                "height": 113,
21                "href": "https://www.youtube.com/oembed?format=json\u0026url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DdQw4w9WgXcQ",
22                "html": "\u003ciframe width=\"200\" height=\"113\" src=\"https://www.youtube.com/embed/dQw4w9WgXcQ?feature=oembed\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" referrerpolicy=\"strict-origin-when-cross-origin\" allowfullscreen title=\"Rick Astley - Never Gonna Give You Up (Official Music Video)\"\u003e\u003c/iframe\u003e",
23                "provider_name": "YouTube",
24                "provider_url": "https://www.youtube.com/",
25                "thumbnail_height": 360,
26                "thumbnail_url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg",
27                "thumbnail_width": 480,
28                "title": "Rick Astley - Never Gonna Give You Up (Official Music Video)",
29                "type": "video",
30                "version": "1.0",
31                "width": 200
32        },
33        "opengraph": {
34                "description": "The official video for “Never Gonna Give You Up” by Rick Astley. Never: The Autobiography 📚 OUT NOW! Follow this link to get your copy and listen to Rick’s ...",
35                "image": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
36                "image:height": "720",
37                "image:width": "1280",
38                "site_name": "YouTube",
39                "title": "Rick Astley - Never Gonna Give You Up (Official Music Video)",
40                "type": "video.other",
41                "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
42                "video:height": "720",
43                "video:secure_url": "https://www.youtube.com/embed/dQw4w9WgXcQ",
44                "video:tag": "never gonna give you up karaoke",
45                "video:type": "text/html",
46                "video:url": "https://www.youtube.com/embed/dQw4w9WgXcQ",
47                "video:width": "1280"
48        },
49        "twitter": {
50                "app:id:googleplay": "com.google.android.youtube",
51                "app:id:ipad": "544007664",
52                "app:id:iphone": "544007664",
53                "app:name:googleplay": "YouTube",
54                "app:name:ipad": "YouTube",
55                "app:name:iphone": "YouTube",
56                "app:url:googleplay": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
57                "app:url:ipad": "vnd.youtube://www.youtube.com/watch?v=dQw4w9WgXcQ\u0026feature=applinks",
58                "app:url:iphone": "vnd.youtube://www.youtube.com/watch?v=dQw4w9WgXcQ\u0026feature=applinks",
59                "card": "player",
60                "description": "The official video for “Never Gonna Give You Up” by Rick Astley. Never: The Autobiography 📚 OUT NOW! Follow this link to get your copy and listen to Rick’s ...",
61                "image": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
62                "player": "https://www.youtube.com/embed/dQw4w9WgXcQ",
63                "player:height": "720",
64                "player:width": "1280",
65                "site": "@youtube",
66                "title": "Rick Astley - Never Gonna Give You Up (Official Music Video)",
67                "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
68        }
69}

Options

<resource>

The first argument to hyperctl graph is the "type" of resource to scrape.

The supported resources types are: entity, or document.

<href>

The second argument to hyperctl graph is the URL of the resource to scrape.

-f, --format

Scraper metadata format.

The supported formats are json or yaml.

--verbose

Standard output verbosity.

Provide the --verbose flag to toggle debug output.