https://github.com/a5huynh/cub-cli

Command-line Utility for Bear Notes
https://github.com/a5huynh/cub-cli

Last synced: 3 months ago
JSON representation

Command-line Utility for Bear Notes

• Host: GitHub
• URL: https://github.com/a5huynh/cub-cli
• Owner: a5huynh
• License: mit
• Created: 2018-07-23T05:06:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-06-24T23:08:27.000Z (over 2 years ago)
• Last Synced: 2023-03-10T22:11:27.837Z (almost 2 years ago)
• Language: Rust
• Homepage:
• Size: 69.3 KB
• Stars: 9
• Watchers: 6
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/a5huynh/cub-cli.svg?branch=master)](https://travis-ci.org/a5huynh/cub-cli) [![license: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## CUB

CUB stands for **C**ommand-line **U**tility for [**B**ear][bear-app] and offers a simple CLI interface

to the notes, tags, and media stored within your bear writer application.

[bear-app]: https://bear.app/

## TODO

- [ ] List notes.

    - [ ] Configure rendering options

      - [x] limit

      - [x] w/ text.

      - [ ] w/ creation/modification date.

    - [x] Filter by note status.

    - [x] Filter by tag.

- [x] View a single note.

- [ ] View fun stats for all notes/note?

## Installing

    brew tap a5huynh/brew

    brew install a5huynh/brew/cub-cli

## How to do things

Here is how to do some common things with the `cub` CLI. Also check out

`cub --help` to see all command/options you can use.

### Listing out notes.

    # List _all_ notes.

    > cub ls

    # Limit output to 10 notes

    > cub ls --limit 10

    > cub ls -l 10

    # List notes w/ full-text

    # BEWARE: If you have a lot of very large notes this _will_ output the

    # entirety of the text to the terminal.

    > cub ls --text

    > cub ls -t

### View a note.

    # Notes are prefixed with their ID in the `ls` command. Use that ID

    # here to output the full text.

    > cub show 571

## Building from scratch

CUB is build using the latest stable version of rust-lang and can be built

from scratch using the following command:

    cargo build --release