{"id":16310670,"url":"https://github.com/nkh/fzf-tldr","last_synced_at":"2025-08-02T02:11:55.395Z","repository":{"id":190601307,"uuid":"682979728","full_name":"nkh/fzf-tldr","owner":"nkh","description":null,"archived":false,"fork":false,"pushed_at":"2023-09-06T12:32:29.000Z","size":196,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-14T06:36:02.694Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nkh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-25T10:05:03.000Z","updated_at":"2024-11-29T19:38:26.000Z","dependencies_parsed_at":"2024-11-06T05:42:30.915Z","dependency_job_id":"7ceb39d2-6d1d-43a5-8c50-090336ab9000","html_url":"https://github.com/nkh/fzf-tldr","commit_stats":null,"previous_names":["nkh/fzf-tldr"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nkh/fzf-tldr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nkh%2Ffzf-tldr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nkh%2Ffzf-tldr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nkh%2Ffzf-tldr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nkh%2Ffzf-tldr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nkh","download_url":"https://codeload.github.com/nkh/fzf-tldr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nkh%2Ffzf-tldr/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268326739,"owners_count":24232496,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T21:42:43.607Z","updated_at":"2025-08-02T02:11:55.371Z","avatar_url":"https://github.com/nkh.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NAME\n\n    fzf-tldr - an unorthodox tldr/snippet client\n\n# SYNOPSIS\n\n    fzf-tldr [command_query]\n\n# DESCRIPTION\n\nA non-conformist tldr. Look in the **See Also** section below if you want a polished client.\n\nAs the names hints, **fzf-tldr** uses, the outstanding, fzf to do some of the work.\n\nWhat makes it different from other tldr client?\n\n- tldr pages are neither downloaded nor update automatically\n    - you can use git for updates, which is much faster than other clients (remember to clone shallow)\n- custom pages\n- multi-line examples\n- placeholders are edited in vim, with gratitude to Bram Moolenaar\n- user defined color\n\n*fzf-tldr* uses a three stage process\n- select a command\n- select one or more examples\n- modify the example in vim if the examples contain placeholders\n\nThe result is output on stdout. \n\n## Select a command from the tldr and custom pages\n\n![UI](https://github.com/nkh/fzf-tldr/blob/main/media/commands.png)\n\n## Select an example\n\n![UI](https://github.com/nkh/fzf-tldr/blob/main/media/examples.png)\n\n## Modify the placeholders\n\n![UI](https://github.com/nkh/fzf-tldr/blob/main/media/edit.png)\n\n# Vim INTEGRATION\n\nExamples containing placeholders are opened in vim.\n\nThe placeholders will be highlighted.\n\nOptionally adding the following code to your *.vimrc* will:\n- source the fzf-tldr vimscript\n- bind \"F3\", or any key you like, to TldrFixall\n\n```\n\" fzf-tldr ------------------------------------------------------\n\nsource $REPO_PATH/fzf-tldr.vim\n\nau BufRead,BufNewFile *.tldr set filetype=tldr\nautocmd FileType tldr nnoremap \u003cbuffer\u003e \u003cF3\u003e :TldrFixAll\u003cCR\u003e\n\n\"optional TldrNext, find next placeholder\n\"optional TldrFix,  fix the placeholder under cursor\n```\n\n## TldrFixAll\n\nA vimscript which will fin all the placeholders and ask for a replacement string.\n\nIf the placeholder is found multiple times, all occurrences will be replaced in interactive mode; press y/n/a/q as usual in vim. \n\n# CONFIGURATION\n\nIn ***$HOME/.config/fzf-tldr***\n\n```\n# minimu config: one of the page locations\n\n# location for custom tldr pages\nCUSTOM_PAGES='/home/.../custom_tldr/'\n\n# multiple locations for tldr pages\nTLDR_PAGES='/home/.../tldr/pages/linux /home/.../tldr/pages/common/'\n\n# colors\nHEADER_COLOR=37\nCOMMENT_COLOR=34\nOPTION_COLOR=33\nPLACEHOLDER_COLOR='1;43'\n```\n\n# INSTALL\n\n*fzf-tldr* consists of these files:\n- $HOME/.config/fzf-tldr, see # CONFIGURATION above\n- fzf-tldr, to be copied in your path\n- color_tldr, to be copied in your path\n    - this can be used to color or flatten the tldr/custom pages without using fzf-tldr\n\n# DEPENDENCIES\n\n- Perl\n- FZF\n- Vim\n\n# SEE ALSO \n\n[intelli-shell](https://github.com/lasantosr/intelli-shell)\n\n[tealdeer](https://github.com/dbrgn/tealdeer)\n\n# AUTHORS\n\n    Khemir Nadim ibn Hamouda\n    https://github.com/nkh\n    CPAN ID: NKH\n\n# LICENCE\n\n© Nadim Khemir 2023, Artistic licence 2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnkh%2Ffzf-tldr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnkh%2Ffzf-tldr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnkh%2Ffzf-tldr/lists"}