# hook CLI

CLI interface for Hook.app (macOS)

> Hook.app is a productivity tool for macOS <https://hookproductivity.com/>. This gem includes a `hook` binary that allows interaction with the features of Hook.app.

*v2.0.3*

## Installation

`gem install hookapp`. 

If you're on a stock Ruby install (i.e. have never installed `rvm` or `rbenv`), you may need sudo and your system password: `sudo gem install hookapp`.

## Usage

Run `hook help` for usage.

```nohighlight
NAME
    hook - CLI interface for Hook.app (macOS)

SYNOPSIS
    hook [global options] command [command options] [arguments...]

VERSION
    0.0.1

GLOBAL OPTIONS
    --help    - Show this message
    --version - Display the program version

COMMANDS
    clip, cp     - Copy Hook URL for file/url to clipboard
    clone        - Clone all hooks from one file or url onto another
    find, search - Search bookmarks
    from         - Get a Hook URL for the frontmost window of an app
    help         - Shows a list of commands or help for one command
    link, ln     - Create bidirectional hooks between two or more 
                   files/urls
    list, ls     - List hooks on a file or url
    open, gui    - Open the specified file or url in Hook GUI
    remove, rm   - Remove a hook between two files/urls
    scripts      - Shell completion examples
    select       - Select from hooks on a file/url and open in default  
                   application
```

Run `hook help COMMAND` on any of the commands for more details.

## Basics

### Creating hooks

The `link` command always creates bidirectional hooks. Give it two or more files or urls and it will create links between them. By default it links all files to the last file in the list. Add the `--all` flag to link all files to every other file in the list. This can be abbreviated as `hook ln -a file1.md file2.pdf "https://brettterpstra.com"`.

Similar to the way you would use the GUI, you can use `hook clip file1.md` to copy a Hook URL to the clipboard (aliased as `cp`), and then use `hook ln -p file2.pdf` to create a link from the clipboard to `file2.pdf`.

You can also clone all of the links on one file to another, great for adding a new file to a group that's fully crosslinked. Just use `hook clone file1.md file2.pdf`.

### Listing hooks

Use the `list` (aliased as `ls`) command to list all attached hooks for a file. With no output format specified, `ls` will show the paths to all hooks, or the hook url if the hook doesn't have a file path (e.g. a URL). You can specify an output format using `--output_format` (abbreviated as `-o`) with one of "markdown", "hooks", "paths", or "verbose". Formats can be abbreviated to their first letter, so to display a Markdown list of all hooked files, use `hook ls -o m file1.md`.

### Removing hooks

Use `hook remove file1.md file2.pdf` to remove the bidirectional link between `file1.md` and `file2.pdf`. Add the `--all` flag (abbr. `-a`) with one or more files to remove ALL the hooks on them. This option requires confirmation.

#### Super nerdy scripting trick

The `--output_format=paths` option (abbr. `-o p`) combined with the `--files_only` flag (abbr. `-f`) will list just the paths and only include hooks that have file paths (i.e. exclude web, email, and other URLs). This can be combined with `--null` to output the list using a NULL separator, perfect for use with `xargs` or other command line tools.

### Acting on hooks

You can open a hooked file or URL by running `hook select file1.md`. This will display a menu of all the hooks on `file1.md`, and entering the number of a selection will open that file in its default application.

You can also open a file in the Hook GUI using `hook open file1.md`.

### Searching hooks

Use `hook find` (or `hook search`) and a search string to find bookmarks containing that string in the title, path, or url. Use `hook find -n` to search bookmark names only. All of the options from `hook ls`/`hook list` (output format, files only, null separator, etc.) work with `find`/`search`. See `hook help find` for details.

`hook find` with no search string will list all bookmarks. This can be used with the same output options as `hook ls`.

### Shell completion

Use `hook scripts [SHELL]` to output a completion script for your specified shell (currently `bash`, `zsh`, or `fish` are available). The comment at the top of the output will guide you to install and utilize the script.
 

## Global Options

### `--help`

Show this message

### `--version`

Display the program version

## Commands

### `$ hook` <mark>`clip|cp`</mark> ` FILE_OR_URL`

*Copy Hook URL for file/url to clipboard*

> Creates a bookmark for the specified file or URL and copies its Hook URL to the clipboard.
> 
> The copied Hook URL can be used to link to other files (use `hook link --paste FILE/URL),
> or to paste into another app as a link. Use the -m flag to copy a full Markdown link.

#### Options

##### `-a` | `--app` APP_NAME

Copy from application

##### `-m`|`--markdown`

Copy as Markdown

* * * * * *

### `$ hook` <mark>`clone`</mark> ` SOURCE TARGET`

*Clone all hooks from one file or url onto another*

> Copy all the files and urls that the first file is hooked to onto another file. Exactly two arguments (SOURCE, TARGET) required.

* * * * * *

### `$ hook` <mark>`find|search`</mark> ` SEARCH_STRING`

*Search bookmarks*

> Search bookmark urls and names for a string and output in specified format (default "paths").
> 
> Run `hook find` with no search argument to list all bookmarks.

#### Options

##### `-o` | `--output_format` format

Output format [(h)ooks, (p)aths, (m)arkdown, (v)erbose]

*Default Value:* `paths`

##### `-f`|`--files_only`

Output only bookmarks with file paths (exclude e.g. emails)

##### `-n`|`--names_only`

Search only bookmark names

##### `--null`

Separate results with NULL separator, only applies with "paths" output for single file argument

* * * * * *

### `$ hook` <mark>`from`</mark> ` APPLICATION_NAME`

*Get a Hook URL for the frontmost window of an app*

> Specify an application by name (without '.app') to bring that app to the foreground and create a bookmark
> for the active document, note, task, etc., returning a Hook URL.
> 
> Use -m to get the response as Markdown, and/or -c to copy the result directly to the clipboard.

#### Options

##### `-c`|`--copy`

Copy to clipboard

##### `-m`|`--markdown`

Output as Markdown

* * * * * *

### `$ hook` <mark>`help`</mark> ` command`

*Shows a list of commands or help for one command*

> Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function

#### Options

##### `-c`

List commands one per line, to assist with shell completion

* * * * * *

### `$ hook` <mark>`link|ln`</mark> ` SOURCE [SOURCE...] TARGET`

*Create bidirectional hooks between two or more files/urls*

> If two files/urls are provided, links will be bi-directional.
> If three or more are provided, `link` defaults to creating bi-directional
> links between each file and the last file in the list. Use `-a` to create
> bi-directional links between every file in the list.
> 
> If using `--paste`, the URL/hook link in the clipboard will be used as one argument,
> to be combined with one or more file/url arguments.

#### Options

##### `-a`|`--all`

Link every listed file or url to every other

##### `-p`|`--paste`

Paste URL from clipboard

* * * * * *

### `$ hook` <mark>`list|ls`</mark> ` FILE_OR_URL [FILE_OR_URL...]`

*List hooks on a file or url*

> Output a list of all hooks attached to given url(s) or file(s) in the specified format (default "paths").
> 
> Run `hook list` with no file/url argument to list all bookmarks.

#### Options

##### `-o` | `--output_format` format

Output format [(h)ooks, (p)aths, (m)arkdown, (v)erbose]

*Default Value:* `paths`

##### `-f`|`--files_only`

Output only bookmarks with file paths (exclude e.g. emails)

##### `--null`

Separate results with NULL separator, only applies with "paths" output for single file argument

##### `-s`|`--[no-]select`

Generate a menu to select hook(s) for opening

> This option is a shortcut to `hook select` and overrides any other arguments.

* * * * * *

### `$ hook` <mark>`open|gui`</mark> ` FILE_OR_URL`

*Open the specified file or url in Hook GUI*

> Opens Hook.app on the specified file/URL for browsing and performing actions. Exactly one argument (File/URL) required.

* * * * * *

### `$ hook` <mark>`remove|rm`</mark> ` ITEM_1 ITEM_2`

*Remove a hook between two files/urls*

> Remove a hook between two files or URLs. If you use --all, all hooks on a given file will be removed.
> 
> If --all isn't specified, exactly two arguments (Files/URLs) are required.

#### Options

##### `-a`|`--all`

Remove ALL links on files, requires confirmation

* * * * * *

### `$ hook` <mark>`scripts`</mark> ` SHELL`

*Shell completion examples*

> Output completion script example for the specified shell (bash, zsh, fish)

* * * * * *

### `$ hook` <mark>`select`</mark> ` FILE_OR_URL`

*Select from hooks on a file/url and open in default application*

> If the target file/URL has hooked items, a menu will be provided. Selecting one or more files
> from this menu will open the item(s) using the default application assigned to the
> filetype by macOS. Allows multiple selections with tab key, and type-ahead fuzzy filtering of results.

* * * * * *

#### [Default Command] help
## Credits

HookApp embeds [Fuzzy Finder](https://github.com/junegunn/fzf) under the [MIT License](https://github.com/junegunn/fzf/blob/master/LICENSE)

HookApp is based on [GLI](https://github.com/davetron5000/gli) for building command line applications in Ruby. [Apache License](https://github.com/davetron5000/gli/blob/main/LICENSE.txt).

## HookApp License

This software is licensed under the MIT License.

	The MIT License (MIT)

	Copyright (c) 2013-2020 Junegunn Choi

	Permission is hereby granted, free of charge, to any person obtaining a copy
	of this software and associated documentation files (the "Software"), to deal
	in the Software without restriction, including without limitation the rights
	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	copies of the Software, and to permit persons to whom the Software is
	furnished to do so, subject to the following conditions:

	The above copyright notice and this permission notice shall be included in
	all copies or substantial portions of the Software.

	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	THE SOFTWARE.


Documentation generated 2020-11-11 09:29