Search commands by name / description

Code snippets

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

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

$ch = curl_init("https://api.oanor.com/tldr-api/v1/search");
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/search",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

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

{
    "data": {
        "count": 20,
        "limit": 20,
        "total": 374,
        "offset": 0,
        "filters": {
            "q": "git",
            "platform": null
        },
        "results": [
            {
                "name": "git",
                "title": "git",
                "platform": "common",
                "description": "Distributed version control system Some subcommands such as `commit`, `add`, `branch`, `switch`, `push`, etc. have their own usage documentation",
                "example_count": 8
            },
            {
                "name": "git-abort",
                "title": "git abort",
                "platform": "common",
                "description": "Abort an ongoing rebase, merge, or cherry-pick Part of `git-extras`",
                "example_count": 1
            },
            {
                "name": "git-add",
                "title": "git add",
                "platform": "common",
                "description": "Stage changed files for a commit",
                "example_count": 8
            },
            {
                "name": "git-alias",
                "title": "git alias",
                "platform": "common",
                "description": "Create shortcuts for Git commands Part of `git-extras`",
                "example_count": 3
            },
            {
                "name": "git-am",
                "title": "git am",
                "platform": "common",
                "description": "Apply patch files and create a commit. Useful when receiving commits via email See also: `git format-patch`",
                "example_count": 4
            },
            {
                "name": "git-annex",
                "title": "git annex",
                "platform": "common",
                "description": "Manage files with Git, without checking their contents in When a file is annexed, its content is moved into a key-value store, and a symlink is made that points to the content",
                "example_count": 6
            },
            {
                "name": "git-annotate",
                "title": "git annotate",
                "platform": "common",
                "description": "Show commit hash and last author on each line of a file See `git blame`, which is preferred over `git annotate` `git annotate` is provided for those familiar with other version control systems",
                "example_count": 3
            },
            {
                "name": "git-apply",
                "title": "git apply",
                "platform": "common",
                "description": "Apply a patch to files and/or to the index without creating a commit See also: `git am`",
                "example_count": 6
            },
            {
                "name": "git-archive",
                "title": "git archive",
                "platform": "common",
                "description": "Create an archive of files from a tree",
                "example_count": 6
            },
 
…