{"id":17956317,"url":"https://github.com/b0o/zfzf","last_synced_at":"2025-03-25T02:31:15.783Z","repository":{"id":43358406,"uuid":"339215810","full_name":"b0o/zfzf","owner":"b0o","description":"zfzf is a fzf-based file picker for zsh which allows you to quickly navigate the directory hierarchy","archived":true,"fork":false,"pushed_at":"2022-03-05T22:40:48.000Z","size":22187,"stargazers_count":24,"open_issues_count":5,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-14T06:53:23.591Z","etag":null,"topics":["directory-traversal","file-picker","fzf","fzf-scripts","linux","shell","term","terminal","zsh","zsh-functions","zsh-plugin"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/b0o.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-15T21:46:29.000Z","updated_at":"2024-12-03T15:35:54.000Z","dependencies_parsed_at":"2022-08-20T00:40:10.038Z","dependency_job_id":null,"html_url":"https://github.com/b0o/zfzf","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b0o%2Fzfzf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b0o%2Fzfzf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b0o%2Fzfzf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b0o%2Fzfzf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/b0o","download_url":"https://codeload.github.com/b0o/zfzf/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245385436,"owners_count":20606648,"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","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":["directory-traversal","file-picker","fzf","fzf-scripts","linux","shell","term","terminal","zsh","zsh-functions","zsh-plugin"],"created_at":"2024-10-29T10:37:16.713Z","updated_at":"2025-03-25T02:31:15.530Z","avatar_url":"https://github.com/b0o.png","language":"Shell","funding_links":[],"categories":["Plugins"],"sub_categories":["ZSH on Windows"],"readme":"# zfzf [![version](https://img.shields.io/github/v/tag/b0o/zfzf?style=flat\u0026color=yellow\u0026label=version\u0026sort=semver)](https://github.com/b0o/zfzf/releases) [![license: MIT](https://img.shields.io/github/license/b0o/zfzf?style=flat\u0026color=green)](https://mit-license.org)\n\n\u003e Zsh + fzf\n\n## Demo\n\n![demonstration screencast](https://user-images.githubusercontent.com/21299126/151639939-0709d636-52e6-45fd-af19-6ce49671c47a.gif)\n\n## Install\n\n```zsh\n# zinit\nzinit light b0o/zfzf\n```\n\n## Usage\n\nzfzf can work in three ways:\n\n- as a standalone utlity by running the `zfzf` command\n- as a ZLE (zsh line editor) plugin via a keyboard shortcut\n- as a Zsh completion for file paths (experimental and buggy)\n\n### As a standalone utility\n\nzfzf can be invoked by running the `zfzf` command and optionally passing a path\nas the first argument. The result will be printed to stdout.\n\n### As a ZLE plugin\n\nBy default, zfzf is mapped to `Alt-period`. If your cursor is adjacent to any\nnon-whitespace text when you trigger zfzf, it will attempt to interpret that\ntext as a path.\n\n### As a Zsh completion function\n\nIf you would like to use zfzf to complete filenames when you press tab, you\nshould call the `enable-zfzf-tab` function in your `.zshrc`.\n\nIf you use other completion plugins like fzf-tab, you should call\n`enable-zfzf-tab` after all other plugins have been loaded and enabled,\notherwise another plugin may override zfzf.\n\nYou can later call `disable-zfzf-tab` to restore the prior completion function.\n\n\u003c!-- USAGE --\u003e\n\n```\n\nzfzf v0.2.0\n\nzfzf is a fzf-based file picker for zsh which allows you to easily navigate the\ndirectory hierarchy and pick files using keybindings.\n\nzfzf can be used as a standalone program, as an explicit zle widget, and as a\nfile path completion. By default, zfzf can be explicitly triggered with Alt-.\n(this is configurable with the ZFZF_ZSH_BINDING option).\n\nIf you would like to use zfzf as your file completion when you press tab, you\nshould call the enable-zfzf-tab function in your .zshrc. If you use other\ncompletion plugins like fzf-tab, you should call enable-zfzf-tab after all\nother plugins have been loaded and enabled. You can later call disable-zfzf-tab\nto restore the prior completion function.\n\nConfiguration Options\n  Environment Variable          Default Value\n\n  ZFZF_ENABLE_COLOR             1\n    When enabled, files and previews will be colorized.\n\n  ZFZF_ENABLE_PREVIEW           1\n    When enabled, the focused item will be displayed in the fzf preview window.\n\n  ZFZF_ENABLE_DOT_DOTDOT        1\n    When enabled, display '.' and '..' at the top of the file listing.\n\n  ZFZF_ZSH_BINDING              ^[. (Alt-.)\n    Sets the keybinding sequence used to trigger zfzf. If set to the empty\n    string, zfzf will not be bound. You can create a keybinding yourself by\n    binding to the zfzf zle widget. See zshzle(1) for more information on key\n    bindings.\n\n  ZFZF_ENABLE_BAT               2\n  ZFZF_ENABLE_EXA               2\n    These options control zfzf's use of non-standard programs. Valid values\n    include:\n      - 0: Disable program\n      - 1: Enable program (Force)\n      - 2: Enable program (Optional)\n    If the value 2 is used, the program will be enabled only if it is found in\n    the PATH or if its path is explicitly specified as described below.\n\n  ZFZF_BAT_PATH                 None\n  ZFZF_EXA_PATH                 None\n    These options allow paths to non-standard programs to be manually\n    specified.\n\nDefault Key Bindings\n\n  return             accept final\n  alt-return         accept final (return absolute path)\n  esc                escape\n  ctrl-g             escape (return absolute path)\n  alt-o              accept query\n  ctrl-d             accept query final\n  alt-P              append query\n  ctrl-o             replace query\n  alt-i              descend into directory or accept file\n  alt-.              descend into directory or accept file\n  alt-u              ascend into parent directory\n  alt-\u003e              ascend into parent directory\n  alt-U              ascend to next existing ancestor\n\n```\n\n\u003c!-- /USAGE --\u003e\n\n## TODO\n\n- [ ] configurable options\n  - [ ] fzf key bindings\n  - [ ] sorting\n  - [ ] filtering\n  - [x] color\n  - [ ] fzf options\n\n## License\n\n\u003c!-- LICENSE --\u003e\n\n\u0026copy; 2021 Maddison Hellstrom\n\nReleased under the MIT License.\n\n\u003c!-- /LICENSE --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb0o%2Fzfzf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fb0o%2Fzfzf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb0o%2Fzfzf/lists"}