- Created by deanishe
- 🗓 Last Updated: 08/12/23 16:20:53
- 🌟 Stars on GitHub: 315
- Please consider supporting the creator by Starring or Sponsoring them on GitHub!
- Get Workflow
- Get Latest Release
- Get Source Code
From their README
Git Repos Workflow for Alfred
Browse, search and open Git repositories from within Alfred.
Download
Get the workflow from GitHub releases.
Versions 2.2+ are not compatible with Alfred 3 and earlier.
For Alfred 3, download version 2.1.2, and for Alfred 2, please download version 1.7.
Usage
This workflow requires some configuration before use. See Configuration for details.
repos [
— Show a list of your Git repos filtered by] ↩
— Open selected repo inapp_default
(see configuration)⌘+↩
— Open selected repo inapp_cmd
(see configuration)⌥+↩
— Open selected repo inapp_alt
(requires configuration)^+↩
— Open selected repo inapp_ctrl
(requires configuration)⇧+↩
— Open selected repo inapp_shift
(requires configuration)fn+↩
— Open selected repo inapp_fn
(requires configuration)⌘⌥+↩
— Open selected repo inapp_cmd_alt
(requires configuration)⌘⌥⇧+↩
— Open selected repo inapp_cmd_alt_shift
(requires configuration)- etc.
- etc.
reposettings
— Opensettings.json
in default JSON editorreposupdate
— Force workflow to update its cached list of repositories. (By default, the list will only be updated—in the background—every 3 hours.)reposhelp
— Open this file in your browser
Configuration
Before you can use this workflow, you have to configure one or more folders in which the workflow should search for Git repos. The workflow uses find
to search for .git
directories, so you shouldn't add huge directory trees to it, and use the depth
option to restrict the search depth. Typically, a depth
of 2
will be what you want (i.e. search within subdirectories of specified directory, but no lower). Add directories to search to the search_dir
array in settings.json
(see below).
The default settings.json
file looks like this:
{
"app_default": "Finder", // ↩ to open in this/these app(s)
"app_cmd": "Terminal", // ⌘+↩ to open in this/these app(s)
"app_alt": null, // ⌥+↩ to open in this/these app(s)
"app_ctrl": null, // ^+↩ to open in this/these app(s)
"app_shift": null, // ⇧+↩ to open in this/these app(s)
"app_fn": null, // fn+↩ to open in this/these app(s)
"global_exclude_patterns": [], // Exclude from all searches
"search_dirs": [
{
"path": "~/delete/this/example", // Path to search. ~/ is expanded
"depth": 2, // Search subdirs of `path`
"name_for_parent": 1, // Name Alfred entry after parent of `.git`. 2 = grandparent of `.git` etc.
"excludes": [ // Excludes specific to this path
"tmp", // Directories named `tmp`
"bad/smell/*" // Subdirs of `bad/smell` directory
]
}
]
}
This is my settings.json
:
{
"app_alt": "iTerm",
"app_cmd": "Finder",
"app_cmd_alt": [
"VSCodium",
"Finder",
"SourceTree",
"iTerm"
],
"app_ctrl": "SourceTree",
"app_default": "VSCodium",
"app_shift": "Browser",
"global_exclude_patterns": [],
"search_dirs": [
{
"depth": 3,
"path": "~/Code"
},
{
"path": "~/Sites"
},
{
"path": "~/src/git.deanishe.net/deanishe"
},
{
"path": "~/src/github.com/deanishe"
}
]
}
Note: If you specify Browser
, Safari
, Google Chrome
, Webkit
or Firefox
as an application, it will be passed the remote repo URL, not the local filepath. Browser
will open the URL in your default browser.
You can also change the default update interval (3h) in the workflow's configuration sheet in Alfred Preferences. Change the UPDATE_EVERY_MINS
workflow variable to suit your needs.
Search Directories
Each entry in the search_dirs
list must be a mapping.
Only path
is required. depth
will default to 2
if not specified. excludes
are globbing patterns, like in .gitignore
.
name_for_parent
defaults to 1
, which means the entry in Alfred's results should be named after the directory containing the .git
directory. If you want Alfred to show the name of the grandparent, set name_for_parent
to 2
etc.
This is useful if your projects are structured, for example, like this and src
is the actual repo:
Code
Project_1
src
other_stuff
Project_2
src
other_stuff
…
…
Set name_for_parent
to 2
, and Project_1
, Project_2
etc. will be shown in Alfred, not src
, src
, src
…
Open in Applications
The applications specified by the app_XYZ
options are all called using open -a AppName path/to/directory
. You can configure any application that can open a directory in this manner. Some recommendations are Sublime Text, SourceTree, GitHub or iTerm.
The meta app Browser
will open the repo's remote/origin
URL in your default browser. Other recognised browsers are Safari
, Google Chrome
, Firefox
and WebKit
.
Note: As you can see from my settings.json
, you can also set an app_XYZ
value to an array of applications to open the selected repo in more than one app at once:
…
"app_cmd": ["Finder", "Sublime Text", "SourceTree", "iTerm"],
…
In versions 3+ (i.e. in Alfred 4), you can also arbitrarily combine modifiers to give yourself many more options:
"app_cmd_alt": "Finder",
"app_shift_alt_cmd": "VSCodium",
"app_cmd_fn_alt": "Oni",
etc.
etc.
Modifiers may be specified in any order. The only requirements are that the key must start with app_
and the modifiers must be separated by _
.
You can also use →
on a result to access Alfred's default File Actions menu.
License, Thanks
This workflow is released under the MIT Licence.
It uses the Alfred-Workflow and docopt libraries (both MIT Licence).
The icon is by Jason Long, from git-scm.com, released under the Creative Commons Attribution 3.0 Unported Licence.