https://github.com/luckman212/alfred-readme-sync
Helper script to push, pull or compare README.md to Alfred workflow
https://github.com/luckman212/alfred-readme-sync
alfred alfred-workflow readme-md script
Last synced: 5 months ago
JSON representation
Helper script to push, pull or compare README.md to Alfred workflow
- Host: GitHub
- URL: https://github.com/luckman212/alfred-readme-sync
- Owner: luckman212
- Created: 2025-03-21T14:05:37.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-04-26T16:40:39.000Z (9 months ago)
- Last Synced: 2025-09-01T09:46:12.856Z (5 months ago)
- Topics: alfred, alfred-workflow, readme-md, script
- Language: Shell
- Homepage: https://www.alfredforum.com/topic/22945-readme-syncer
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# alfred-readme-sync
A helper script to push, pull or compare a `README.md` from the local git repo to what is configured in an Alfred workflow.
See https://www.alfredforum.com/topic/22945-readme-syncer for discussion.
Copy to your `$PATH` somewhere and make sure it has `+x` executable bit set.
## Usage
Run with `-h`, `--help` to show syntax.
```
$ alfred-readme-sync.sh
Display, push, or pull README between Alfred workflow and filesystem
Usage: alfred-readme-sync.sh
-c,--compare compare README.md <-> Alfred's config version
--copy copy Alfred's readme to pasteboard
--push copy README.md in → Alfred's readme
--pull copy Alfred's readme out → README.md
```
## N.B.
When run with the `-c`/`--compare` flag it will check for and install the [`icdiff`](https://www.jefftk.com/icdiff) tool for better terminal diff output. If you inspect the source, you will find some alternate tools if you prefer, including `sdiff` which is included in the base OS.