{"id":13646668,"url":"https://github.com/abo-abo/swiper","last_synced_at":"2025-04-10T02:14:15.302Z","repository":{"id":28403850,"uuid":"31918222","full_name":"abo-abo/swiper","owner":"abo-abo","description":"Ivy - a generic completion frontend for Emacs, Swiper - isearch with an overview, and more. Oh, man!","archived":false,"fork":false,"pushed_at":"2025-03-29T15:16:46.000Z","size":8842,"stargazers_count":2344,"open_issues_count":433,"forks_count":339,"subscribers_count":50,"default_branch":"master","last_synced_at":"2025-04-10T02:13:56.068Z","etag":null,"topics":["completion","counsel","emacs","ivy","search","swiper"],"latest_commit_sha":null,"homepage":"https://oremacs.com/swiper/","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/abo-abo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.org","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,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"abo-abo","liberapay":"abo-abo","patreon":"abo_abo"}},"created_at":"2015-03-09T19:29:06.000Z","updated_at":"2025-04-07T07:10:50.000Z","dependencies_parsed_at":"2023-01-14T08:45:24.250Z","dependency_job_id":"1b03307c-2be7-424f-8076-0795520977fe","html_url":"https://github.com/abo-abo/swiper","commit_stats":{"total_commits":3183,"total_committers":243,"mean_commits":"13.098765432098766","dds":"0.34370091109016654","last_synced_commit":"d28225e86f8dfb3825809ad287f759f95ee9e479"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abo-abo%2Fswiper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abo-abo%2Fswiper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abo-abo%2Fswiper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abo-abo%2Fswiper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abo-abo","download_url":"https://codeload.github.com/abo-abo/swiper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248142902,"owners_count":21054671,"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":["completion","counsel","emacs","ivy","search","swiper"],"created_at":"2024-08-02T01:03:02.611Z","updated_at":"2025-04-10T02:14:15.274Z","avatar_url":"https://github.com/abo-abo.png","language":"Emacs Lisp","readme":"[![Build Status](https://github.com/abo-abo/swiper/actions/workflows/test.yml/badge.svg)](https://github.com/abo-abo/swiper/actions/workflows/test.yml)\n\n***flexible, simple tools for minibuffer completion in Emacs***\n\nThis repository contains:\n\n**Ivy**, a generic completion mechanism for Emacs.\n\n**Counsel**, a collection of Ivy-enhanced versions of common Emacs\ncommands.\n\n**Swiper**, an Ivy-enhanced alternative to Isearch.\n\n# Ivy\n\n[![GNU-devel ELPA](https://elpa.gnu.org/devel/ivy.svg)](https://elpa.gnu.org/devel/ivy.html)\n[![GNU ELPA](https://elpa.gnu.org/packages/ivy.svg)](https://elpa.gnu.org/packages/ivy.html)\n[![MELPA](https://melpa.org/packages/ivy-badge.svg)](https://melpa.org/#/ivy)\n[![MELPA Stable](https://stable.melpa.org/packages/ivy-badge.svg)](https://stable.melpa.org/#/ivy)\n\nIvy is a generic completion mechanism for Emacs.  While it operates\nsimilarly to other completion schemes such as `icomplete-mode`, Ivy\naims to be more efficient, smaller, simpler, and smoother to use yet\nhighly customizable.\n\nTo try Ivy, just call \u003ckbd\u003eM-x\u003c/kbd\u003e `ivy-mode`.  This will enable\ngeneric Ivy completion, including specific completion for file and\nbuffer names.\n\n### Installation\n\nInstall the `ivy` package from GNU ELPA or MELPA.\n\nUsers of Debian ≥10 (and derivatives such as Ubuntu ≥18.04) can\ninstall Ivy, Counsel, and Swiper with `sudo apt install elpa-counsel`.\nTo add Hydra support: `sudo apt install elpa-ivy-hydra`.\n\n## Documentation\n\n### Manual\n\nInstalling `ivy` from GNU ELPA or MELPA also installs the manual under\nthe `(ivy)` Info node.\n\nThe source file for the Info page is [here](doc/ivy.org).\n\nThe manual is also available as [HTML](https://elpa.gnu.org/packages/doc/ivy.html).\n\n### Wiki\n\nIvy and Swiper wiki [is here](https://github.com/abo-abo/swiper/wiki).\n\n### Small config example\n\n```elisp\n(ivy-mode)\n(setopt ivy-use-virtual-buffers t)\n(setopt enable-recursive-minibuffers t)\n;; Enable this if you want `swiper' to use it:\n;; (setopt search-default-mode #'char-fold-to-regexp)\n(keymap-global-set \"C-s\" #'swiper-isearch)\n(keymap-global-set \"C-c C-r\" #'ivy-resume)\n(keymap-global-set \"\u003cf6\u003e\" #'ivy-resume)\n(keymap-global-set \"M-x\" #'counsel-M-x)\n(keymap-global-set \"C-x C-f\" #'counsel-find-file)\n(keymap-global-set \"\u003cf1\u003e f\" #'counsel-describe-function)\n(keymap-global-set \"\u003cf1\u003e v\" #'counsel-describe-variable)\n(keymap-global-set \"\u003cf1\u003e o\" #'counsel-describe-symbol)\n(keymap-global-set \"\u003cf1\u003e l\" #'counsel-find-library)\n(keymap-global-set \"\u003cf2\u003e i\" #'counsel-info-lookup-symbol)\n(keymap-global-set \"\u003cf2\u003e u\" #'counsel-unicode-char)\n(keymap-global-set \"C-c g\" #'counsel-git)\n(keymap-global-set \"C-c j\" #'counsel-git-grep)\n(keymap-global-set \"C-c k\" #'counsel-ag)\n(keymap-global-set \"C-x l\" #'counsel-locate)\n(keymap-global-set \"C-S-o\" #'counsel-rhythmbox)\n(keymap-set minibuffer-local-map \"C-r\" #'counsel-minibuffer-history)\n```\n\nNote: parts of this config can be replaced by using `counsel-mode`.\n\n# Counsel\n\n[![GNU-devel ELPA](https://elpa.gnu.org/devel/counsel.svg)](https://elpa.gnu.org/devel/counsel.html)\n[![GNU ELPA](https://elpa.gnu.org/packages/counsel.svg)](https://elpa.gnu.org/packages/counsel.html)\n[![MELPA](https://melpa.org/packages/counsel-badge.svg)](https://melpa.org/#/counsel)\n[![MELPA Stable](https://stable.melpa.org/packages/counsel-badge.svg)](https://stable.melpa.org/#/counsel)\n\n`ivy-mode` ensures that any Emacs command invoking `completing-read`\nor `completion-in-region` will use Ivy for completion.\n\nCounsel takes this further, providing versions of common Emacs\ncommands that are customized to make the best use of Ivy.  For\nexample, `counsel-find-file` has some additional keybindings.\nPressing \u003ckbd\u003eDEL\u003c/kbd\u003e will move you to the parent directory.\n\nEnabling `counsel-mode` remaps built-in Emacs functions that have\nCounsel replacements:\n\n| Emacs command              | Counsel counterpart          |\n|----------------------------|------------------------------|\n| `execute-extended-command` | `counsel-M-x`                |\n| `describe-bindings`        | `counsel-descbinds`          |\n| `describe-function`        | `counsel-describe-function`  |\n| `describe-variable`        | `counsel-describe-variable`  |\n| `describe-symbol`          | `counsel-describe-symbol`    |\n| `apropos-command`          | `counsel-apropos`            |\n| `describe-face`            | `counsel-describe-face`      |\n| `list-faces-display`       | `counsel-faces`              |\n| `find-file`                | `counsel-find-file`          |\n| `find-library`             | `counsel-find-library`       |\n| `imenu`                    | `counsel-imenu`              |\n| `load-library`             | `counsel-load-library`       |\n| `load-theme`               | `counsel-load-theme`         |\n| `yank-pop`                 | `counsel-yank-pop`           |\n| `info-lookup-symbol`       | `counsel-info-lookup-symbol` |\n| `pop-to-mark-command`      | `counsel-mark-ring`          |\n| `bookmark-jump`            | `counsel-bookmark`           |\n\n# Swiper\n\n[![GNU-devel ELPA](https://elpa.gnu.org/devel/swiper.svg)](https://elpa.gnu.org/devel/swiper.html)\n[![GNU ELPA](https://elpa.gnu.org/packages/swiper.svg)](https://elpa.gnu.org/packages/swiper.html)\n[![MELPA](https://melpa.org/packages/swiper-badge.svg)](https://melpa.org/#/swiper)\n[![MELPA Stable](https://stable.melpa.org/packages/swiper-badge.svg)](https://stable.melpa.org/#/swiper)\n\nSwiper is an alternative to Isearch that uses Ivy to show an overview\nof all matches.\n\n![swiper.png](https://oremacs.com/download/swiper.png)\n\nA Helm version of Swiper is also available:\n[`swiper-helm`](https://github.com/abo-abo/swiper-helm).\n\n## Screenshots\n\n![ivy-swiper-1.png](https://oremacs.com/download/ivy-swiper-1.png)\n\nThere's also a ten minute [video demo](https://youtu.be/VvnJQpTFVDc).\n\n# Frequently asked questions\n\n- Q: How do I enter an input that matches one of the candidates\n  instead of this candidate?  Example: create a file `bar` when a file\n  `barricade` exists in the current directory.\n\n- A: Press \u003ckbd\u003eC-M-j\u003c/kbd\u003e.  Alternatively, you can make the prompt\n  line selectable with:\n  ```elisp\n  (setopt ivy-use-selectable-prompt t)\n  ```\n\n# Contributing\n\nPlease see the [guidelines](CONTRIBUTING.org) for reporting issues and\nopening pull requests.\n","funding_links":["https://github.com/sponsors/abo-abo","https://liberapay.com/abo-abo","https://patreon.com/abo_abo"],"categories":["Emacs Lisp","HarmonyOS"],"sub_categories":["Windows Manager"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabo-abo%2Fswiper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabo-abo%2Fswiper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabo-abo%2Fswiper/lists"}