Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unforswearing/lnks
Print and / or save your Google Chrome links from the terminal on MacOS
https://github.com/unforswearing/lnks
bash google-chrome instapaper lnks macos pinboard
Last synced: 3 months ago
JSON representation
Print and / or save your Google Chrome links from the terminal on MacOS
- Host: GitHub
- URL: https://github.com/unforswearing/lnks
- Owner: unforswearing
- Created: 2015-12-02T03:15:02.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-07-27T15:03:49.000Z (5 months ago)
- Last Synced: 2024-09-30T17:03:03.102Z (3 months ago)
- Topics: bash, google-chrome, instapaper, lnks, macos, pinboard
- Language: Shell
- Homepage:
- Size: 817 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# lnks
List / Save / Instapaper your Google Chrome links from the terminal (on OS X/MacOS)
## Installation
Clone this repository to use the latest version of `lnks`:
```console
$ git clone https://github.com/unforswearing/lnks.git .
$ cd lnks
$ source lnks
$ lnks -h
```
Or install using `npm`
```console
$ npm install -g lnks
```
## Usage
```console
lnks
Options:
-s|--save save the links to a file on the desktop
-c|--copy copy the links to your clipboard
-p|--print print the links to stdout
-m|--markdown print links with markdown formatting: [title](url) (requires 'html-xml-utils')
-i|--instapaper save the link(s) to instapaper
-b|--pinboard save the link(s) to pinboard.in (requires 'html-xml-utils')
-w|--pdf save each url as a pdf (requires 'wkhtmltopdf')
-h|--help print this help message
Note:
- lnks accepts one option. the program will fail if run with more than one option.
- lnks will allow multiple options in a future version
```
`lnks` stores credentials in the `.lnks.conf` file located in your home directory. Revoke credentials at any time by deleting specific line(s) or the entire file. All data stored in `.lnks.conf` is private and will never be used for any purpose other than allowing you to save links to either service mentioned below.
If you choose the Instapaper or Pinboard options, `lnks` will ask for information to autheticate your accounts with those services.
- For Instapaper, you will need your **user name** and **password**
- Pinboard access requires your **API token**
- This can be found at [https://pinboard.in/settings/password](https://pinboard.in/settings/password).
## Dependencies
**Required**
- Applescript (`osascript`)
- Standard command line utilities: `awk`, `curl`, `grep`, `sed`, etc.
**Optional**
> `lnks` is basically functional without these tools, however they must be installed to use specific `lnks` options.
- HTML-XML-utils: [https://www.w3.org/Tools/HTML-XML-utils/README](https://www.w3.org/Tools/HTML-XML-utils/README)
- to get page titles from processed urls, used with `--markdown` and `--pinboard` options.
- PDF creation (`lnks --pdf`)
- `wkhtmltopdf` is required to save the url/webpage as a pdf.
- Visit [http://wkhtmltopdf.org/downloads.html](http://wkhtmltopdf.org/downloads.html).
## To Do / Roadmap
- Clean up code, add comments, make everything more readable
- Feature: Read a list of links from a file and execute a single `lnks` option for each
- eg. `lnks --read urls.txt --pdf`
- Feature: Add support for [raindrop.io](https://raindrop.io) (if possible)
- Feature: Create a plugin system and extract Instapaper and Pinboard as "plugins"
- eg. `lnks --plugin path/to/lnks_instapaper.bash "search-term"`