{"openapi":"3.1.0","info":{"title":"tldr CLI Help API","version":"1.0.0","description":"Simplified, example-driven help for the command line as an API — the community tldr-pages project, 7,045 command-line tools across Linux, macOS, Windows and more. Instead of dense man pages, every command (tar, git, ffmpeg, curl, docker, ssh, awk, …) comes back as a short description plus a handful of practical, copy-paste example commands with placeholders. Look up a command, search commands by name or description, filter by platform, or fetch a random command. Ideal for terminals, IDEs, chatbots, developer tools, onboarding and learning. Open data from tldr-pages (CC-BY).","contact":{"name":"PremiumApi","url":"https://www.oanor.com/by/premiumapi"}},"servers":[{"url":"https://api.oanor.com/tldr-api","description":"oanor gateway"}],"tags":[{"name":"tldr"},{"name":"Meta"}],"components":{"securitySchemes":{"oanorKey":{"type":"apiKey","in":"header","name":"x-oanor-key","description":"Get your key at https://www.oanor.com/developer/keys"}}},"security":[{"oanorKey":[]}],"paths":{"/v1/command":{"get":{"operationId":"get_v1_command","tags":["tldr"],"summary":"Full tldr page for a command","description":"","parameters":[{"name":"name","in":"query","required":true,"description":"Command name, e.g. tar, git, ffmpeg","schema":{"type":"string"},"example":"tar"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"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}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/random":{"get":{"operationId":"get_v1_random","tags":["tldr"],"summary":"A random command","description":"","parameters":[{"name":"platform","in":"query","required":false,"description":"Restrict to a platform","schema":{"type":"string"}}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"command":{"name":"devfsadm","title":"devfsadm","examples":[{"command":"devfsadm -c disk","description":"Scan for new disks"},{"command":"devfsadm -C -v","description":"Cleanup any dangling `/dev` links and scan for new device"},{"command":"devfsadm -C -v -n","description":"Dry-run - output what would be changed but make no modifications"}],"platform":"sunos","more_info":"https://www.unix.com/man-page/sunos/1m/devfsadm","description":"Administer `/dev` Maintains the `/dev` namespace","example_count":3}},"meta":{"timestamp":"2026-05-31T09:49:21.174Z","request_id":"dc0580eb-f325-4f94-8e5f-bfaba3bc80bc"},"status":"ok","message":"Random command retrieved","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/search":{"get":{"operationId":"get_v1_search","tags":["tldr"],"summary":"Search commands by name / description","description":"","parameters":[{"name":"q","in":"query","required":false,"description":"Search term","schema":{"type":"string"},"example":"git"},{"name":"platform","in":"query","required":false,"description":"common | linux | osx | windows | android","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Results per page (1-100, default 20)","schema":{"type":"string"},"example":"20"},{"name":"offset","in":"query","required":false,"description":"Pagination offset","schema":{"type":"string"},"example":"0"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"count":20,"limit":20,"total":374,"offset":0,"filters":{"q":"git"},"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},{"name":"git-archive-file","title":"git archive-file","platform":"common","description":"Export all the files of the current Git branch into a Zip archive Part of `git-extras`","example_count":1},{"name":"git-authors","title":"git authors","platform":"common","description":"Generate a list of committers of a Git repository Part of `git-extras`","example_count":3},{"name":"git-bisect","title":"git bisect","platform":"common","description":"Use binary search to find the commit that introduced a bug Git automatically jumps back and forth in the commit graph to progressively narrow down the faulty commit","example_count":8},{"name":"git-blame","title":"git blame","platform":"common","description":"Show what commit and author last modified each line of a file","example_count":8},{"name":"git-blame-someone-else","title":"git blame-someone-else","platform":"common","description":"Blame someone else for your bad code","example_count":1},{"name":"git-branch","title":"git branch","platform":"common","description":"Main Git command for working with branches","example_count":8},{"name":"git-browse","title":"git browse","platform":"common","description":"View an upstream repository in the default browser Part of `git-extras`","example_count":2},{"name":"git-browse-ci","title":"git browse-ci","platform":"common","description":"Open the current Git repository's CI website in the default web browser Part of `git-extras`","example_count":2},{"name":"git-brv","title":"git brv","platform":"common","description":"Print a list of branches, sorted by last commit date Part of `git-extras`","example_count":1},{"name":"git-bug","title":"git bug","platform":"common","description":"A distributed bug tracker that uses Git's internal storage, so no files are added in your project You may submit your problems to the same Git remote you use to interact with others, much like commits and branches","example_count":7},{"name":"git-bugreport","title":"git bugreport","platform":"common","description":"Capture debug information from the system and user, generating a text file to aid in the reporting of a bug in Git","example_count":3}]},"meta":{"timestamp":"2026-05-31T09:49:21.252Z","request_id":"2d2a6153-a375-413a-b994-07410acd1733"},"status":"ok","message":"Commands searched","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/meta":{"get":{"operationId":"get_v1_meta","tags":["Meta"],"summary":"Totals & platforms","description":"","parameters":[],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"note":"Simplified, example-driven help pages for command-line tools (the tldr-pages project). /v1/command returns the full page (description + practical example commands); /v1/search finds commands by name or description; /v1/random returns a random command.","total":7045,"fields":["name","platform","title","description","more_info","example_count","examples"],"source":"tldr-pages/tldr (CC-BY)","by_platform":{"dos":10,"osx":312,"linux":1932,"sunos":10,"common":4537,"netbsd":1,"android":13,"freebsd":4,"openbsd":3,"windows":212,"cisco-ios":11}},"meta":{"timestamp":"2026-05-31T09:49:21.329Z","request_id":"710de600-b683-49ac-8433-096e40529cc0"},"status":"ok","message":"Meta retrieved","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}}},"x-oanor-pricing":[{"slug":"free","name":"Free","price_cents_month":0,"monthly_call_quota":3400,"rps_limit":2,"hard_limit":true},{"slug":"starter","name":"Starter","price_cents_month":390,"monthly_call_quota":48000,"rps_limit":8,"hard_limit":true},{"slug":"pro","name":"Pro","price_cents_month":1210,"monthly_call_quota":239000,"rps_limit":20,"hard_limit":true},{"slug":"mega","name":"Mega","price_cents_month":3300,"monthly_call_quota":1195000,"rps_limit":50,"hard_limit":true}],"x-oanor-marketplace-url":"https://www.oanor.com/api/tldr-api"}