Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/deanishe/alfred-fuzzyfolders

Fuzzy search across folder subdirectories
https://github.com/deanishe/alfred-fuzzyfolders

alfred alfred-workflow fuzzy-search python workflow

Last synced: about 2 months ago
JSON representation

Fuzzy search across folder subdirectories

Host: GitHub
URL: https://github.com/deanishe/alfred-fuzzyfolders
Owner: deanishe
License: mit
Created: 2014-03-09T20:15:08.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2021-12-15T15:35:26.000Z (over 2 years ago)
Last Synced: 2024-02-10T00:06:14.944Z (5 months ago)
Topics: alfred, alfred-workflow, fuzzy-search, python, workflow
Language: Python
Size: 6.3 MB
Stars: 57
Watchers: 6
Forks: 9
Open Issues: 3
Metadata Files:
- Readme: README.md

Lists

awesome-stars - deanishe/alfred-fuzzyfolders - Fuzzy search across folder subdirectories (Python)

README

# Fuzzy Folders Alfred Workflow #

Fuzzy search across folder subtrees. Add your own keywords to directly search specific folders.

![](https://github.com/deanishe/alfred-fuzzyfolders/raw/master/demo.gif "")

This Workflow provides partial matching of path components, allowing you to drill down into your filesystem with a space-separated query. Each "word" of the query will be matched against the components of a directory or file's path, so a three-word query will only match at least three levels down from the specified root directory.

You can use a **File Action** to intiate a fuzzy search on a folder or to assign a keyword to perform a fuzzy search on that folder.

## Download ##

Get the Workflow from [GitHub](https://github.com/deanishe/alfred-fuzzyfolders/releases/latest) or [Packal](http://www.packal.org/workflow/fuzzy-folders).

## Commands ##

- `fuzzy` — List your Fuzzy Folders
+ `↩` — Edit Fuzzy Folder settings
+ `⌘+↩` — Start a Fuzzy Folder search with the associated keyword
+ `⌥+↩` — Delete the keyword–Fuzzy Folder combination
- `fzyup` — Recreate the Script Filters from your saved configuration (useful after an update)
- `fzyhelp` — Open the help file in your browser

## Settings ##

You can specify these settings globally as defaults for all Fuzzy Folders or on a per-folder basis. For ad-hoc searches via the `Fuzzy Search Here` file action, the default settings always apply.

Use keyword `fuzzy` to view and edit settings.

- **Minimum query length** — The last "word" of a query must be this long to trigger a search. Default is `1`, but increase this number if the search is too slow. This is very often the case if you're searching a large subtree and/or also choose to search files.
- **Search scope** — Choose to search only for folders, files or both. **Note:** In most cases, searches including files are significantly slower. Consider increasing the **minimum query length** to speed up slow searches.

## File Actions ##

- `Fuzzy Search Here` — Fuzzy search this folder
- `Add Fuzzy Folder` — Set a keyword for this folder for faster fuzzy searching

## Search result actions ##

- `↩` — Open folder in Finder
- `⌘+↩` — Browse folder in Alfred

## Excludes ##

Fuzzy Folders supports global and folder-specific glob-style excludes (similar to `.gitignore`).

Currently, these can only be configured by editing the `settings.json` file by hand. To open `settings.json`, enter the query `fuzzy workflow:opendata` into Alfred. This will open the workflow's data directory in Finder and reveal the `settings.json` file.

The `settings.json` file will look something like this:

```json
{
"defaults": {
"min": 2,
"scope": 1
},
"profiles": {
"1": {
"dirpath": "/Users/dean/Documents",
"keyword": "docs"
},
"2": {
"dirpath": "/Users/dean/Code",
"excludes": [
"*.pyc",
"/alfred-*"
],
"keyword": "code",
"scope": 3
},
"3": {
"dirpath": "/Volumes/Media/Video",
"keyword": "vids",
"scope": 3
},
"4": {
"dirpath": "/Users/dean/Documents/Translations",
"excludes": [],
"keyword": "trans"
}
}
}
```

The `defaults` key may not be present if you haven't changed the default settings and won't have an `excludes` member. Any `profiles` (saved fuzzy folders) added using a version of the workflow with support for excludes will be created with an empty list for the key `excludes`, but `profiles` created with earlier versions won't have an `excludes` member. Add it by hand.

`excludes` should be a list of strings containing `.gitignore`/shell-style patterns, e.g.:

```json
"excludes": [
"*.pyc",
"/alfred-*"
],
```

In contrast to the other default settings, `min` (minimum query length) and `scope` (search folders (1), files (2) or both (3)), the default `excludes` will be added to folder-specific ones, not replaced by them.

So to exclude compiled Python files from all fuzzy folders, add `*.pyc` to the `excludes` list under `defaults`:

```json
{
"defaults": {
"min": 2,
"scope": 1,
"excludes": ["*.pyc"]
}
}
```

## Bugs, questions, feedback ##

You can [open an issue on GitHub](https://github.com/deanishe/alfred-fuzzyfolders/issues), or post on the [Alfred Forum](http://www.alfredforum.com/topic/4042-fuzzy-folders/).

## Licensing, other stuff ##

This Workflow is made available under the [MIT Licence](http://opensource.org/licenses/MIT).

The icon was made by [Jono Hunt](http://iconaholic.com/).

It uses [docopt](https://github.com/docopt/docopt) and [Alfred-Workflow](https://github.com/deanishe/alfred-workflow).