{"id":13588281,"url":"https://github.com/pmeinhardt/ql","last_synced_at":"2025-05-12T13:41:50.419Z","repository":{"id":141524411,"uuid":"601809262","full_name":"pmeinhardt/ql","owner":"pmeinhardt","description":"Quick Look from the command-line 👀","archived":false,"fork":false,"pushed_at":"2025-03-04T09:35:02.000Z","size":444,"stargazers_count":11,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-15T06:24:02.497Z","etag":null,"topics":["cli","macos","quicklook","terminal"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pmeinhardt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-02-14T21:39:41.000Z","updated_at":"2025-03-06T01:59:36.000Z","dependencies_parsed_at":"2024-10-24T17:53:02.784Z","dependency_job_id":"0f930f3e-3ff8-4d0d-bc68-11889d16cae7","html_url":"https://github.com/pmeinhardt/ql","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmeinhardt%2Fql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmeinhardt%2Fql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmeinhardt%2Fql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmeinhardt%2Fql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pmeinhardt","download_url":"https://codeload.github.com/pmeinhardt/ql/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246553049,"owners_count":20795835,"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":["cli","macos","quicklook","terminal"],"created_at":"2024-08-01T15:06:36.994Z","updated_at":"2025-05-12T13:41:50.398Z","avatar_url":"https://github.com/pmeinhardt.png","language":"Swift","funding_links":[],"categories":["Swift"],"sub_categories":[],"readme":"# ql\n\n[![checks](https://github.com/pmeinhardt/ql/actions/workflows/checks.yml/badge.svg)](https://github.com/pmeinhardt/ql/actions/workflows/checks.yml)\n\n| Allows you to preview files from the command-line | Integrates with Vim/Neovim         |\n| ------------------------------------------------- | ---------------------------------- |\n| ![](./media/screenshot-macos.png)                 | ![](./media/screenshot-neovim.png) |\n\nPreview files from the command-line using macOS Quick Look.\n\nOpen a file in Quick Look from the command-line:\n\n```shell\nql \u003cpath/to/file\u003e\n```\n\nYes, there is `qlmanage`. But you’d always have `[DEBUG]` staring at you.\n\n## Installing 📦\n\nYou can install `ql` via Homebrew:\n\n```shell\nbrew install --HEAD pmeinhardt/tools/ql\n```\n\nThis will build the tool from source.\n\nTo update, use:\n\n```shell\nbrew upgrade --fetch-HEAD pmeinhardt/tools/ql\n```\n\n## Building 🪛\n\nIn order to build the `ql` command, run:\n\n```shell\nswift build --configuration release\n```\n\nThis requires macOS 12.0+ with `swift` installed.\n\nYou can copy the resulting binary anywhere you like or add the `.build/release` directory to your `PATH`.\n\n## Vim plugin 🔩\n\nThere is a Vim plugin for `ql`. If you use [vim-plug](https://github.com/junegunn/vim-plug), add this line to your Vim configuration file:\n\n```vim\nPlug 'pmeinhardt/ql', {'do': ':QuickLookCompile'}\n```\n\nThe plugin provides a `:QuickLook [path]` command and `\u003cPlug\u003e` mappings. If you invoke it without a `[path]`, it will show a preview of the current buffer contents. See [`.vimrc.develop`](./.vimrc.develop) for usage examples.\n\nYou can use the plugin, even if you cannot build `ql` itself. If the `ql` binary is not found, the plugin will fall back to using `qlmanage` if available or `open`. In this case, leave out the `{'do': ':QuickLookCompile'}` part of the plugin integration above to avoid build errors when upgrading your Vim plugins.\n\nIt is probably possible to integrate other file previewers like [GNOME sushi](https://gitlab.gnome.org/GNOME/sushi). If you are up for it, I am happy about pull-requests.\n\n## Markdown 🚲\n\nIf you want to preview Markdown files without additional Quick Look plugins, take a look at Maxdown:\nhttps://github.com/pmeinhardt/maxdown\n\n## References\n\n- https://developer.apple.com/documentation/quicklook\n- https://developer.apple.com/documentation/quicklookui\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmeinhardt%2Fql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpmeinhardt%2Fql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmeinhardt%2Fql/lists"}