# alfred-link

> Make your Alfred workflows installable from npm

Latest version **0.3.1** (published 2019-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install alfred-link
pnpm add alfred-link
yarn add alfred-link
bun add alfred-link
```

Provides the commands `alfred-link`, `alfred-unlink`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2019-08-29 |
| First published | 2016-08-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 9 |
| Unpacked size | 8.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 71 |
| Author | Sam Verschueren |
| Maintainers | samverschueren, sindresorhus |
| Keywords | cli-app, cli, alfred, link, symlink, packal |

## Links

- npm: https://www.npmjs.com/package/alfred-link
- Repository: https://github.com/SamVerschueren/alfred-link
- Homepage: https://github.com/SamVerschueren/alfred-link#readme
- Issues: https://github.com/SamVerschueren/alfred-link/issues
- npm.io page: https://npm.io/package/alfred-link

## Dependencies (9)

- [del](https://npm.io/package/del.md) ^2.2.2
- [pify](https://npm.io/package/pify.md) ^2.3.0
- [plist](https://npm.io/package/plist.md) ^2.0.1
- [make-dir](https://npm.io/package/make-dir.md) ^1.3.0
- [user-home](https://npm.io/package/user-home.md) ^2.0.0
- [sudo-block](https://npm.io/package/sudo-block.md) ^1.2.0
- [path-exists](https://npm.io/package/path-exists.md) ^3.0.0
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^1.0.1
- [resolve-alfred-prefs](https://npm.io/package/resolve-alfred-prefs.md) ^2.0.0

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 0.3.1 (latest) — 2019-08-29
- 0.3.0 — 2018-11-04
- 0.2.1 — 2017-09-11
- 0.2.0 — 2016-11-06
- 0.1.4 — 2016-09-09
- 0.1.3 — 2016-09-02
- 0.1.2 — 2016-09-01
- 0.1.1 — 2016-08-26
- 0.1.0 — 2016-08-21

## README

# alfred-link [![Build Status](https://travis-ci.org/SamVerschueren/alfred-link.svg?branch=master)](https://travis-ci.org/SamVerschueren/alfred-link)

> Make your [Alfred](https://www.alfredapp.com/) workflows installable from npm


## Install

```
$ npm install --save alfred-link
```


## Supporting Versions

- Alfred 3
- Alfred 4

This package will only affect the latest one if you have multiple versions in your system.


## Usage

Add the `alfred-link` command as `postinstall` script of your Alfred package and add `alfred-unlink` as `preuninstall` script to clean up the resources when the workflow gets uninstalled.

```json
{
  "name": "alfred-unicorn",
  "scripts": {
    "postinstall": "alfred-link",
    "preuninstall": "alfred-unlink"
  }
}
```

You can now install the `alfred-unicorn` package like this

```
$ npm install -g alfred-unicorn
```

This will update `info.plist` with the information from `package.json` and creates a `unicorn` symlink inside the Alfred workflows directory that points to the location of the `alfred-unicorn` module.


## info.plist

This package will update the `info.plist` file when the workflow is being installed. The following properties in `info.plist` can be safely omitted. The corresponding values in `package.json` are added to the plist file.

| info.plist  | package.json |
|-------------|--------------|
| version     | version      |
| description | description  |
| webaddress  | homepage     |
| createdby   | author.name  |


## Development

When developing an Alfred workflow, you can call `alfred-link` directly from your cli. Use `npx` to call the local installation of `alfred-link` and `alfred-unlink`.

```
$ npx alfred-link
```

This will create a symlink in the Alfred workflows directory pointing to your development location without transforming `info.plist`.

To remove the symlink afterwards, you can call `alfred-unlink`.

```
$ npx alfred-unlink
```


## Related

- [alfy](https://github.com/sindresorhus/alfy) - Create Alfred workflows with ease


## License

MIT © [Sam Verschueren](https://github.com/SamVerschueren)

---
_Source: https://npm.io/package/alfred-link · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._