Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/majidsajadi/paperboard
Paperboard, is a cli application for managing a reading list of bookmarks from the Internet.
https://github.com/majidsajadi/paperboard
bookmarks cli cli-application javascript node-js nodejs
Last synced: 6 days ago
JSON representation
Paperboard, is a cli application for managing a reading list of bookmarks from the Internet.
- Host: GitHub
- URL: https://github.com/majidsajadi/paperboard
- Owner: majidsajadi
- License: mit
- Created: 2020-03-15T13:08:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T19:44:45.000Z (almost 2 years ago)
- Last Synced: 2024-10-05T16:36:01.380Z (about 1 month ago)
- Topics: bookmarks, cli, cli-application, javascript, node-js, nodejs
- Language: JavaScript
- Homepage:
- Size: 3.6 MB
- Stars: 82
- Watchers: 2
- Forks: 4
- Open Issues: 21
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- jimsghstars - majidsajadi/paperboard - Paperboard, is a cli application for managing a reading list of bookmarks from the Internet. (JavaScript)
README
## Paperboard, is under development. You may encounter bugs or there will be breaking changes.
Paperboard
Paperboard, is a cli application for managing a reading list of bookmarks from the Internet.
## Install
### Yarn
```bash
yarn global add paperboard
```
### NPM
```bash
npm install --global paperboard
```
## Usage
```
$ paperboard --help
Usage: paperboard [options] [command]
Options:
-h, --help display help for command
Commands:
list [options] display bookmarks
show display a bookmark
add [tags...] add new bookmark
delete delete bookmark
star star/unstar bookmark
archive archive/restore bookmark
set-tags|set-tag [tags...] set bookmark tags
open open bookmark url in browser
read read bookmark offline
run run paperboard web application
help [command] display help for command
```
## Highlights
- Simple and minimal web interface
- Organize bookmarks, add, edit, delete and search
- Archive and restore bookmarks
- Star & unstar mechanisms
- Simple and minimal command line interface
- Uses sqlite3 as its database
- Reading bookmarks offlane
- Make bookmarks more readable by removing extra stuffs
## Development
Any contribution, pull requests, issue and feedbacks would be greatly appreciated.
- Fork the repository and clone it to your machine
- Navigate to your local fork: `cd paperboard`
- Install the project dependencies: `npm install` or `yarn install`
## License
[MIT](https://github.com/majidsajadi/paperboard/blob/master/license)