Keep It

Keep It is an app for organizing notes, files, web links, and lists. Protocol Launcher allows you to generate URLs to open Keep It items and lists, add content, and append text or attachments.

Usage

There are two ways to use this library:

• On-Demand import from subpaths enables tree-shaking and keeps bundles small.
• Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand

Recommended. Optimized for production.

Full Import

Convenient. Good for quick scripts.

Notes

This module only wraps the official Keep It URL Support surface: keepit://link?item=..., keepit://link?list=..., keepit://x-callback-url/add?..., and keepit://x-callback-url/append?....

The add and append helpers URL-encode parameters and support the standard x-callback parameters mentioned by Keep It's documentation. For tags, Keep It's official examples keep the comma separator unescaped, so the generated URL does the same.

URL Methods

Open Item

Open a Keep It item by identifier.

On-Demand

import { openItem } from 'protocol-launcher/keepit'

const url = openItem({
  item: 'C96F26E6-A566-457E-A448-5B0F527714DE',
})

Open Item in Keep It

Open List

Open a Keep It list by identifier.

On-Demand

import { openList } from 'protocol-launcher/keepit'

const url = openList({
  list: 'AllItems',
})

Open List in Keep It

Add Web Link

Add a web link to Keep It.

On-Demand

import { add } from 'protocol-launcher/keepit'

const url = add({
  name: 'Apple Homepage',
  source: 'http://apple.com',
})

Add Web Link to Keep It

Add Note

Add text as a Keep It note or text file.

On-Demand

import { add } from 'protocol-launcher/keepit'

const url = add({
  text: 'The quick brown fox',
  list: 'AllItems',
})

Add Note to Keep It

Append Text

Append text to a Keep It item.

On-Demand

import { append } from 'protocol-launcher/keepit'

const url = append({
  text: 'The quick brown fox',
  item: 'C96F26E6-A566-457E-A448-5B0F527714DE',
})

Append Text in Keep It

Generated URLs

openItem(itemLinkParams)
// => 'keepit://link?item=C96F26E6-A566-457E-A448-5B0F527714DE'

openList(listLinkParams)
// => 'keepit://link?list=AllItems'

add(addWebLinkParams)
// => 'keepit://x-callback-url/add?name=Apple%20Homepage&source=http%3A%2F%2Fapple.com'

add(addNoteParams)
// => 'keepit://x-callback-url/add?text=The%20quick%20brown%20fox&list=AllItems'

append(appendTextParams)
// => 'keepit://x-callback-url/append?text=The%20quick%20brown%20fox&item=C96F26E6-A566-457E-A448-5B0F527714DE'

Official Documentation

• Keep It URL Support