Full tldr page for a command

Code snippets

curl "https://api.oanor.com/tldr-api/v1/command" \
  -H "x-oanor-key: oanor_test_..."

await fetch("https://api.oanor.com/tldr-api/v1/command", {
  headers: { "x-oanor-key": "oanor_test_..." }
});

$ch = curl_init("https://api.oanor.com/tldr-api/v1/command");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);

import requests
requests.get(
    "https://api.oanor.com/tldr-api/v1/command",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

A real response from this endpoint, captured by the latest health check.

{
    "data": {
        "command": {
            "name": "tar",
            "title": "tar",
            "examples": [
                {
                    "command": "tar cf {{path/to/target.tar}} {{path/to/file1 path/to/file2 ...}}",
                    "description": "[c]reate an archive and write it to a [f]ile"
                },
                {
                    "command": "tar czf {{path/to/target.tar.gz}} {{path/to/file1 path/to/file2 ...}}",
                    "description": "[c]reate a g[z]ipped archive and write it to a [f]ile"
                },
                {
                    "command": "tar czf {{path/to/target.tar.gz}} {{[-C|--directory]}} {{path/to/directory}} .",
                    "description": "[c]reate a g[z]ipped (compressed) archive from a directory using relative paths"
                },
                {
                    "command": "tar xvf {{path/to/source.tar[.gz|.bz2|.xz]}}",
                    "description": "E[x]tract a (compressed) archive [f]ile into the current directory [v]erbosely"
                },
                {
                    "command": "tar xf {{path/to/source.tar[.gz|.bz2|.xz]}} {{[-C|--directory]}} {{path/to/directory}}",
                    "description": "E[x]tract a (compressed) archive [f]ile into the target directory"
                },
                {
                    "command": "tar caf {{path/to/target.tar.xz}} {{path/to/file1 path/to/file2 ...}}",
                    "description": "[c]reate a compressed archive and write it to a [f]ile, using the file extension to [a]utomatically determine the compression program"
                },
                {
                    "command": "tar tvf {{path/to/source.tar}}",
                    "description": "Lis[t] the contents of a tar [f]ile [v]erbosely"
                },
                {
                    "command": "tar xf {{path/to/source.tar}} --wildcards \"{{*.html}}\"",
                    "description": "E[x]tract files matching a pattern from an archive [f]ile"
                }
            ],
            "platform": "common",
            "more_info": "https://www.gnu.org/software/tar/manual/tar.html",
            "description": "Archiving utility Often combined with a compression method, such as `gzip` or `bzip2`",
            "example_count": 8
        }
    },
    "meta": {
        "timestamp": "2026-05-31T09:49:21.126Z",
        "request_id": "6b6afea3-b71f-4f04-8dbd-9bf95c7325fd"
    },
    "status": "ok",
    "message": "Command page retrieved",
    "success": true
}