• Stars
    star
    286
  • Rank 144,690 (Top 3 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created almost 6 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A reliable org-capture browser extension for Chrome/Firefox

Grasp is a browser extension for Chrome and Firefox, which adds a button/keybinding to capture current page title and url, possibly selected text, additional comments or tags and adds it into your Org Mode file.

Screenshot, short demo.

Running

In the simplest setup, the server runs locally, and you can use 'localhost' version of the extension. If you have to work on a computer where you can't run python scripts, or your target capture file is just not there, you can selfhost the server part elsewhere and use the 'any host' version. Don't forget to set the endpoint in extension settings!

  1. Install server counterpart as systemd service (to autostart it): server/setup --path /path/to/your/capture.org [--port <custom port>] [--template <custom org-capture template>].

    Or alternatively, just run it directly if you don't want to autostart it: server/grasp_server.py --path /path/to/your/capture.org [--port <custom_port>] [--template <custom org-capture template>].

  2. Install chrome extension and configure hotkeys

That's it! If you're using custom port make sure it's the same as in the extension settings (default is 12212).

Configuration

Here you can find some references for the --template syntax.

If you are looking for more flexible formatting that's not supported by template syntax, see config.py.example. You can modify it to your liking and pass as --config to grasp_server/setup scripts.

Motivation

Why use org-capture? Well, it's hard to explain, maybe some other time... However, if you do know you want to use it instead of/alongside your browser bookmarks, by default you don't have much choice and have to copy everything manually. For an experienced enough org-mode user it's no less than a torture.

This tool:

  • + shows a notification when capturing fails/succeeds, so you won't lose your notes

  • + doesn't require always running Emacs, simply appends an org-mode text entry to a file

  • + can capture things that org-protocol can't handle (e.g. extra comment or tags)

  • + can potentially use any plaintext format as a storage.

    E.g. you might be more of a Markdown or Todo.txt fan (let me know if you are interested in that!).

  • - doesn't talk to Emacs, so can't benefit from Emacs capture templates

    E.g. currently you can't point at a specific header in an org file, it would just append at the end.

  • - requires running a small HTTP server

    However, there are no dependencies apart from python3, so in many ways, it's even more portable than Emacs.

Comparison with similar tools:

org-capture-extension

  • - relies on org-protocol and MIME handler: flaky for many people and has no feedback whether capture failed or succeeded

    Losing few days of captured stuff due to MIME handler mysteriously not working was the main motivator for me to develop grasp.

  • - requires always running Emacs, which might not be the case for some people

  • + relies on org-protocol, so can potentially be better integrated with Emacs and your org-mode files

org-protocol-capture-html

Same pros/cons as org-capture-extension as it's relying on org-protocol.

In addition:

  • + using a bookmarklet, hence browser-agnostic
  • + capable of on the fly HTML to org-mode markup conversion

Requirements

No third party dependencies! Just python3.

Potential improvements

Permissions used

  • http://localhost/capture for talking with the backend

    If you want to use an external URL as an endpoint, you will be prompted for a permission dynamically.

  • storage for settings

  • notifications for showing notification

  • activeTab for requesting page info

Building & developing

The most up-to-date instructions should be in CI config.

You need npm for building the extension.

npm install
./build --target <browser> # e.g. ./build --target chrome or ./build --target firefox

After that you can find the extension in dist directory and 'Load unpacked** if necessary. There is also Flow and Eslint set up.

testing and linting

Check CI config to figure out all the checks I'm doing.

The only test(s) that don't run on CI at the moment (e.g. due to lack of X server) are marked with @skip_if_ci. You can run them manually though.

Extra tests (not integrated in CI yet):

  • scripts/test_with_browser.py

publishing

  • run ./publish to generate extension zip files

  • firefox: ./build --firefox --release --lint --sign

    After than, upload the signed xpi file on AMO

  • chrome: ./build --chrome --release --lint

    After that, upload the zip (generated by publish script) on Web store

Credits

More Repositories

1

promnesia

Another piece of your extended mind
Python
1,534
star
2

HPI

Human Programming Interface 🧑👽🤖
Python
1,252
star
3

cloudmacs

Selfhost your Emacs and access it in browser
Shell
431
star
4

orgparse

Python module for reading Emacs org-mode files
Python
323
star
5

orger

Tool to convert data into searchable and interactive org-mode views
Python
274
star
6

cachew

Transparent and persistent cache/serialization powered by type hints
Python
189
star
7

pockexport

Export/access your Pocket data, including highlights!
Python
148
star
8

rexport

Reddit takeout: export your account data as JSON: comments, submissions, upvotes etc. 🦖
Python
137
star
9

kobuddy

Kobo database backup and parser: extracts notes, highlights, reading progress and more
Python
104
star
10

beepb00p

My blog!
Python
73
star
11

exobrain

My external brain 🧠
67
star
12

fbmessengerexport

Export/access you Messenger/Facebook chat messages
Python
60
star
13

ghexport

Export your Github activity: events, repositories, stars, etc.
Python
39
star
14

myinfra

A diagram of my personal infrastructure
Python
38
star
15

dron

What if cron and systemd had a baby?
Python
35
star
16

hypexport

Export/access your Hypothes.is data: annotations and profile info
Python
33
star
17

spotifyexport

Export your personal Spotify data: playlists, saved tracks/albums/shows, etc. as JSON
Python
29
star
18

instapexport

Export your personal Instapaper data: bookmarked articles and highlights
Python
27
star
19

arctee

Atomic tee
Python
24
star
20

telegram-backup-to-txt

Tool to dump telegram into text files for quick search (e.g. with grep)
Python
23
star
21

axol

Personal news feed: search for results on Reddit/Pinboard/Twitter/Hackernews and read as RSS
Python
23
star
22

pinbexport

Export your bookmarks from Pinboard
Python
22
star
23

inorganic

Convert python structures into org-mode
Python
21
star
24

dashboard

Python
18
star
25

goodrexport

Goodreads data export
Python
17
star
26

dotemacs

Emacs config (Doom/Spacemacs) + supplementary files and scripts
Emacs Lisp
14
star
27

telegram2org

Tool to create TODO tasks from Telegram messages in one tap
Python
14
star
28

bleanser

Tool for cleaning old and redundant backups
Python
11
star
29

blinkist-backup

Extract your blinkist hightlights and library books
Python
11
star
30

open-in-editor

Script to jump into files in you text editor, from your web browser
Python
9
star
31

exobrain-md

8
star
32

stexport

Export and access your Stackexchange data
Python
8
star
33

rescuexport

Export/access your Rescuetime data
Python
8
star
34

vkdump

Script for VK.com backup
Python
7
star
35

sufs

Merge multiple directories into one via symlinks
Python
7
star
36

scrapyroo

Full text search over deliveroo restaurants
JavaScript
6
star
37

exobrain-compiler

Scripts I'm using to generate my exobrain
Emacs Lisp
6
star
38

cofunctor-pl

Haskell
5
star
39

autohash

AutoValue extension which speeds up `hashCode` calculation for immutable objects
Java
5
star
40

monzoexport

Tool to export your Monzo transactions
Python
4
star
41

checker-fenum-android-demo

Demo setup for using Checker Framework custom @Fenum annotations in your Android project
Java
4
star
42

pymplate

My Python project template
Python
4
star
43

emfitexport

Python
4
star
44

exports

Various data export scripts that don't deserve a separate repository yet
Python
3
star
45

endoexport

Export/access your Endomondo data
Python
3
star
46

hpi-personal-overlay

Python
3
star
47

mreddit

Simple script to check whether some of your subreddits are not in a multireddit
Python
3
star
48

nordvpn-kill-switch

Tool to prevent DNS leaks. Discontinued in favor of jotyGill/openpyn-nordvpn
Shell
3
star
49

beepb00p-raw

Raw plaintext export of my blog posts
3
star
50

qm-reverse-engineering

Reverse engineering quantified-mind.com
Python
2
star
51

RobolectricPowermock

Java
2
star
52

hpi_fission_talk

Talk on 20210422
CSS
2
star
53

bt-wifi-reconnect

Make BT Wifi great again
Python
2
star
54

kython

A collection of common python stuff I use
Python
2
star
55

scripts

Various personal scripts
Python
2
star
56

porg

Library for xpath-like org-mode queries
Python
2
star
57

haveibeenpwned

Script to track changes on haveibeenpwned (discontinued in favor of https://monitor.firefox.com)
Python
2
star
58

ruci

Rust
1
star
59

karlicoss.github.io

Staging for my blog
HTML
1
star
60

mydata

Public bits of my personal data
1
star
61

gcal-quickeradd

Python
1
star
62

lagrangians

Jupyter Notebook
1
star
63

my-awesome-list

Awesome stuff I am using
1
star
64

masters-thesis

TeX
1
star
65

exobrain-logseq

CSS
1
star
66

exporthelpers

Python
1
star
67

hsbc-parser

Extract transaction data from HSBC credit card PDF statements
Python
1
star
68

dominatepp

Dominate++
Python
1
star
69

hypothesis-top-annotators

Python
1
star
70

scrapyroo-slides

CSS
1
star
71

android-template

My empty Android project template
Groovy
1
star
72

python_duplicate_warnings_investigation

Python
1
star
73

promnesia-demos

Binary assets for Promnesia
1
star
74

.emacs.d

My emacs config
Emacs Lisp
1
star
75

backup-trees

Python
1
star
76

rtm-backup

Script to backup your Remember The Milk account data
Python
1
star
77

dropbox-paranoid

Tool to detect Dropbox conflicts and prevent symlink mess
Python
1
star
78

syncthing-paranoid

Python
1
star