<!-- toc -->

• Install
• Usage
• Update
• Commands

<!-- tocstop -->

Install

Ensure you have NodeJS 12 or later installed. Then run the following:

$ npm install --global @sloansparger/bear

Once you've installed Bear CLI, you will want to authenticate the CLI to allow for full access to Bear's features.

$ bear auth [API_TOKEN]

Additionally, Bear CLI ships with autocomplete for bash and zsh. Follow the prompts by running:

$ bear autocomplete

Usage

$ bear COMMAND
$ bear --version
$ bear --help [COMMAND]

Update

Bear CLI includes and update helper, to get make sure you have the latest version, run:

$ bear update

Contribution

Right now the project would greatly benefit from people posting their workflows using this CLI. Feel free to contribute an example by adding a markdown file to the examples directory.

Commands

<!-- commands -->

• bear add-file [FILE]
• bear add-text [TEXT]
• bear archive [ID]
• bear auth API-TOKEN
• bear autocomplete [SHELL]
• bear change-font [FONT]
• bear change-theme [THEME]
• bear commands
• bear create [TEXT]
• bear delete-tag [NAME]
• bear grab-url [URL]
• bear help [COMMAND]
• bear locked [SEARCH]
• bear open-note [ID]
• bear open-tag [NAME]
• bear rename-tag NAME [NEW-NAME]
• bear search [TERM]
• bear tags
• bear today [SEARCH]
• bear todo [SEARCH]
• bear trash [ID]
• bear untagged [SEARCH]
• bear update [CHANNEL]

bear add-file [FILE]

Append or prepend a file to a note identified by its title or id.

USAGE
  $ bear add-file [FILE]

ARGUMENTS
  FILE  path to file you want to add

OPTIONS
  -c, --edit                                     place the cursor inside the note editor
  -e, --new-window                               open the note in an external window
  -h, --help                                     show CLI help
  -i, --id=id                                    note unique identifier
  -j, --filename=filename                        override file name including extension

  -m, --mode=prepend|append|replace|replace_all  [default: append] the allowed values are prepend, append, replace_all
                                                 and replace (keep the note's title untouched)

  -n, --title=title                              note title

  -o, --open-note                                display the new note in Bear's main or external window

  -u, --header=header                            note title

  -w, --show-window                              force the opening of bear main window

DESCRIPTION
  This call can't be performed if the app is a locked state.
  Encrypted notes can't be accessed with this call.
  Returns note's contents.

See code: src/commands/add-file.ts

bear add-text [TEXT]

Append or prepend text to a note identified by its title or id.

USAGE
  $ bear add-text [TEXT]

ARGUMENTS
  TEXT  note body

OPTIONS
  -c, --edit                                     place the cursor inside the note editor
  -d, --timestamp                                prepend the current date and time to the text
  -e, --new-window                               open the note in an external window
  -h, --help                                     show CLI help
  -i, --id=id                                    note unique identifier

  -l, --new-line                                 if true and mode is append force the text to appear on a new line
                                                 inside the note

  -m, --mode=prepend|append|replace|replace_all  [default: append] the allowed values are prepend, append, replace_all
                                                 and replace (keep the note's title untouched)

  -n, --title=title                              note title

  -o, --open-note                                display the new note in Bear's main or external window

  -t, --tag=tag                                  tag for note

  -u, --header=header                            note title

  -w, --show-window                              force the opening of bear main window

  -x, --exclude-trashed                          exclude trashed notes

DESCRIPTION
  Beta encrypted notes can't be accessed with this call.
  Returns note's contents.

See code: src/commands/add-text.ts

bear archive [ID]

Move a note to bear archive and select the Archive sidebar item.

USAGE
  $ bear archive [ID]

ARGUMENTS
  ID  note unique identifier

OPTIONS
  -h, --help           show CLI help
  -s, --search=search  string to search. search term is ignored if an id is provided.
  -w, --show-window    force the opening of bear main window

DESCRIPTION
  This call can't be performed if the app is a locked state.
  Encrypted notes can't be accessed with this call.

See code: src/commands/archive.ts

bear auth API-TOKEN

Authenticates Bear CLI commands that require an app generated token to work.

USAGE
  $ bear auth API-TOKEN

ARGUMENTS
  API-TOKEN  application token

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  Go to Bear → Help → API Token → Copy Token and paste into this command.

See code: src/commands/auth.ts

bear autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ bear autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ bear autocomplete
  $ bear autocomplete bash
  $ bear autocomplete zsh
  $ bear autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

bear change-font [FONT]

Change the selected Bear Font.

USAGE
  $ bear change-font [FONT]

ARGUMENTS
  FONT  font name

OPTIONS
  -h, --help         show CLI help
  -w, --show-window  force the opening of bear main window

See code: src/commands/change-font.ts

bear change-theme [THEME]

Change the selected Bear theme.

USAGE
  $ bear change-theme [THEME]

ARGUMENTS
  THEME  theme name

OPTIONS
  -h, --help         show CLI help
  -w, --show-window  force the opening of bear main window

DESCRIPTION
  Some themes may require a Bear Pro subscription.

See code: src/commands/change-theme.ts

bear commands

list all the commands

USAGE
  $ bear commands

OPTIONS
  -h, --help  show CLI help
  -j, --json  output in json format
  --hidden    also show hidden commands

See code: @oclif/plugin-commands

bear create [TEXT]

Create a new note. Empty notes are not allowed.

USAGE
  $ bear create [TEXT]

ARGUMENTS
  TEXT  note body

OPTIONS
  -a, --file=file          path to a file attachment
  -c, --edit               place the cursor inside the note editor
  -d, --timestamp          prepend the current date and time to the text
  -e, --new-window         open the note in an external window
  -h, --help               show CLI help
  -j, --filename=filename  override file name including extension
  -n, --title=title        note title
  -o, --open-note          display the new note in Bear's main or external window
  -p, --pin                pin the note to the top of the list
  -t, --tag=tag            tag for note
  -w, --show-window        force the opening of bear main window

DESCRIPTION
  Returns unique note identifier of new note.

See code: src/commands/create.ts

bear delete-tag [NAME]

Delete an existing tag.

USAGE
  $ bear delete-tag [NAME]

ARGUMENTS
  NAME  tag name

OPTIONS
  -h, --help         show CLI help
  -w, --show-window  force the opening of bear main window

DESCRIPTION
  This call can't be performed if the app is a locked state.
  If the tag contains any locked note this call will not be performed.

See code: src/commands/delete-tag.ts

bear grab-url [URL]

Create a new note with the content of a web page.

USAGE
  $ bear grab-url [URL]

ARGUMENTS
  URL  url to grab

OPTIONS
  -h, --help     show CLI help
  -p, --pin      pin the note to the top of the list
  -t, --tag=tag