{"id":13653317,"url":"https://github.com/bbatsov/helm-projectile","last_synced_at":"2025-04-05T09:08:35.378Z","repository":{"id":45647675,"uuid":"48315287","full_name":"bbatsov/helm-projectile","owner":"bbatsov","description":"Helm UI for Projectile","archived":false,"fork":false,"pushed_at":"2023-10-23T14:25:42.000Z","size":353,"stargazers_count":322,"open_issues_count":27,"forks_count":72,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-05-01T22:00:58.307Z","etag":null,"topics":["emacs","helm","projectile"],"latest_commit_sha":null,"homepage":null,"language":"Emacs Lisp","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/bbatsov.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"bbatsov","patreon":"bbatsov","custom":"https://www.paypal.me/bbatsov"}},"created_at":"2015-12-20T10:07:07.000Z","updated_at":"2024-04-02T18:58:27.000Z","dependencies_parsed_at":"2024-01-13T17:10:07.312Z","dependency_job_id":null,"html_url":"https://github.com/bbatsov/helm-projectile","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbatsov%2Fhelm-projectile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbatsov%2Fhelm-projectile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbatsov%2Fhelm-projectile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbatsov%2Fhelm-projectile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bbatsov","download_url":"https://codeload.github.com/bbatsov/helm-projectile/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247312081,"owners_count":20918344,"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":["emacs","helm","projectile"],"created_at":"2024-08-02T02:01:08.608Z","updated_at":"2025-04-05T09:08:35.335Z","avatar_url":"https://github.com/bbatsov.png","language":"Emacs Lisp","funding_links":["https://github.com/sponsors/bbatsov","https://patreon.com/bbatsov","https://www.paypal.me/bbatsov","https://www.patreon.com/bbatsov"],"categories":["Emacs Lisp"],"sub_categories":[],"readme":"[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)\n[![MELPA](http://melpa.org/packages/helm-projectile-badge.svg)](http://melpa.org/#/helm-projectile)\n[![MELPA Stable](http://stable.melpa.org/packages/helm-projectile-badge.svg)](http://stable.melpa.org/#/helm-projectile)\n[![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/bbatsov)\n\n## Helm Projectile\n\n[Projectile](https://github.com/bbatsov/projectile) can be integrated\nwith [Helm](https://github.com/emacs-helm/helm) via\n`helm-source-projectile-projects`,\n`helm-source-projectile-files-list`,\n`helm-source-projectile-buffers-list` and\n`helm-source-projectile-recentf-list` sources (available in\n`helm-projectile.el`). There is also an example function for calling\nHelm with the Projectile file source. You can call it like this:\n\n```\nM-x helm-projectile\n```\n\nor even better - invoke the key binding \u003ckbd\u003eh\u003c/kbd\u003e in Projectile's\nkeymap. Assuming you've opted for one of the recommended keymap prefixes (`C-c p`\nor `s-p`), that would mean \u003ckbd\u003eC-c p h\u003c/kbd\u003e or \u003ckbd\u003es-p h\u003c/kbd\u003e.\n\nSee Projectile's [installation docs](https://docs.projectile.mx/projectile/installation.html#installation-via-package-el) for more details.\n\n## Project Status\n\nThe project is currently looking for more maintainers. I (Bozhidar) don't use Helm myself and\ndon't have much time for the project, so I would definitely appreciate some help with it.\n\nContact me via e-mail or GitHub if you'd like to become a co-maintainer.\n\n## Installation\n\nThe recommended way to install helm-projectile is via `package.el`.\n\n### package.el\n\n#### MELPA\n\nYou can install a snapshot version of helm-projectile from the\n[MELPA](http://melpa.org) repository. The version of\nProjectile there will always be up-to-date, but it might be unstable\n(albeit rarely).\n\n#### MELPA Stable\n\nYou can install the last stable version of helm-projectile from the\n[MELPA Stable](http://stable.melpa.org) repository.\n\n### el-get\n\nhelm-projectile is also available for installation from the\n[el-get](https://github.com/dimitri/el-get) package manager.\n\n### Emacs Prelude\n\nhelm-projectile is naturally part of the\n[Emacs Prelude](https://github.com/bbatsov/prelude). If you're a Prelude\nuser - helm-projectile is already properly configured and ready for\naction.\n\n### Debian and Ubuntu\n\nUsers of Debian 9 or later or Ubuntu 16.04 or later may `apt\ninstall elpa-helm-projectile`.\n\n## Usage\n\nFor those who prefer helm to ido/ivy, the command `helm-projectile-switch-project`\ncan be used to replace `projectile-switch-project` to switch project. Please\nnote that this is different from simply setting `projectile-completion-system`\nto `helm`, which just enables projectile to use the Helm completion to complete\na project name. The benefit of using `helm-projectile-switch-project` is that on\nany selected project we can fire many actions, not limited to just the \"switch\nto project\" action, as in the case of using helm completion by setting\n`projectile-completion-system` to `helm`. Currently, there are five actions:\n\"Switch to project\", \"Open Dired in project's directory\", \"Open project root in\nvc-dir or magit\", \"Switch to Eshell\" and \"Grep project files\". We will add more\nand more actions in the future.\n\n`helm-projectile` is capable of opening multiple files by marking the files with\n\u003ckbd\u003eC-SPC\u003c/kbd\u003e or mark all files with \u003ckbd\u003eM-a\u003c/kbd\u003e. Then, press \u003ckbd\u003eRET\u003c/kbd\u003e,\nall the selected files will be opened.\n\nNote that the helm grep is different from `projectile-grep` because the helm\ngrep is incremental. To use it, select your projects (select multiple projects\nby pressing C-SPC), press \"C-s\" (or \"C-u C-s\" for recursive grep), and type your\nregexp. As you type the regexp in the mini buffer, the live grep results are\ndisplayed incrementally.\n\n`helm-projectile` also provides Helm versions of common Projectile commands. Currently,\nthese are the supported commands:\n\n* `helm-projectile-switch-project`\n* `helm-projectile-find-file`\n* `helm-projectile-find-file-in-known-projects`\n* `helm-projectile-find-file-dwim`\n* `helm-projectile-find-dir`\n* `helm-projectile-recentf`\n* `helm-projectile-switch-to-buffer`\n* `helm-projectile-grep` (can be used for both grep or ack)\n* `helm-projectile-ag`\n* `helm-projectile-rg`\n* Replace Helm equivalent commands in `projectile-commander`\n* A virtual directory manager that is unique to Helm Projectile\n\nWhy should you use these commands compared with the normal Projectile\ncommands, even if the normal commands use `helm` as\n`projectile-completion-system`? The answer is, Helm specific commands\ngive more useful features. For example,\n`helm-projectile-switch-project` allows opening a project in Dired,\nMagit or Eshell. `helm-projectile-find-file` reuses actions in\n`helm-find-files` (which is plenty) and able to open multiple\nfiles. Another reason is that in a large source tree, helm-projectile\ncould be slow because it has to open all available sources.\n\nIf you want to use these commands, you have to activate it to replace\nthe normal Projectile commands:\n\n```el\n;; (setq helm-projectile-fuzzy-match nil)\n(require 'helm-projectile)\n(helm-projectile-on)\n```\n\nIf you already activate helm-projectile key bindings and you don't\nlike it, you can turn it off and use the normal Projectile bindings\nwith command `helm-projectile-off`. Similarly, if you want to disable\nfuzzy matching in Helm Projectile (it is enabled by default), you must\nset `helm-projectile-fuzzy-match` to nil before loading\n`helm-projectile`.\n\nTo fully learn Helm Projectile and see what it is capable of, you\nshould refer to this guide:\n[Exploring large projects with Projectile and Helm Projectile](http://tuhdo.github.io/helm-projectile.html).\n\nObviously you need to have Helm installed for this to work. :-)\n\n![Helm-Projectile Screenshot](screenshots/helm-projectile.png)\n\n## Known issues\n\nCheck out the project's\n[issue list](https://github.com/bbatsov/helm-projectile/issues?sort=created\u0026direction=desc\u0026state=open)\na list of unresolved issues. By the way - feel free to fix any of them\nand sent me a pull request. :-)\n\n## Contributors\n\nHere's a [list](https://github.com/bbatsov/helm-projectile/contributors) of all the people who have contributed to the\ndevelopment of Projectile.\n\n## Changelog\n\nA fairly extensive changelog is available [here](CHANGELOG.md).\n\n**Note:** We started keeping track of changes there after version 1.0.\n\n## License\n\nCopyright © 2011-2025 Bozhidar Batsov and\n[contributors](https://github.com/bbatsov/helm-projectile/contributors).\n\nDistributed under the GNU General Public License, version 3\n\n[badge-license]: https://img.shields.io/badge/license-GPLv3-blue.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbatsov%2Fhelm-projectile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbbatsov%2Fhelm-projectile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbatsov%2Fhelm-projectile/lists"}