Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 3.03 KB

README.md

File metadata and controls

73 lines (50 loc) · 3.03 KB
Raw

Helm Project

This package provides a Helm interface for the built in project.el Emacs library.

Notable Features

  • Inherits from built-in helm sources. e.g. act on project buffers using any of the helm buffer actions, open project files with root as you could when using helm file actions. Search within open project buffers using the @ prefix, just as you could when using helm-mini or helm-buffers-list.

  • Supports project.el external roots: If your project definition supports multiple roots, search and act across all of them at once.

Installing

Install helm-project directly from MELPA

Configuration

(use-package helm-project
  :bind (("C-x C-p" . helm-project)
	 ("M-s p" . helm-project-grep-ag)
	 ([remap project-find-regexp] . helm-project-grep-ag)
	 ([remap project-switch-to-buffer] . helm-project-buffers)
	 ([remap project-find-file] . helm-project-files)
	 ([remap project-switch-project] . helm-project-list-projects)
	 :map helm-project-map
         ;; Any changes to keybinds on the helm-project-map should be made
         ;; before initializing the sources for the first time, i.e. before
         ;; calling any of the `helm-project-*' commands.
	 ("C-c s" . helm-project-grep-ag)))

Commands

helm-project-list-projects - project-switch-project

helm-project-files - project-find-files

helm-project-buffers - project-switch-to-buffer

helm-project-grep-ag - project-find-regexp. May also be called from within a helm-project-* buffer with M-g a.

helm-project - This is the main entry point, and combines above three helm sources into a single interface.

helm-project-toggle-external-flag - Only bound when within a helm-project-* buffer, used to toggle search space between project root directory, and project root directory + external roots. Bound to C-c a by default.

Examples

helm-project-files Using helm-project to find a project file.

helm-project-grep-ag Using helm-project-grep-ag within helm-project to locate a definition within a project.

Bound by default to M-g a when within a helm buffer, as per helm conventions.

helm-project-file-actions Showing inherited helm actions on project files.

helm-project-search-in-buffer Narrowing across open project buffers to those which contain "helm-project-source".

Links

Helm Homepage

Working with Projects - Emacs Manual

Project.el Emacs Mirror