Skip to content

Commit

Permalink
0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
sloansparger committed Jun 7, 2020
1 parent e4564f6 commit 73f0ac4
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 51 deletions.
104 changes: 55 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@
![](https://user-images.githubusercontent.com/7104357/83909151-1cf61180-a71d-11ea-81ab-2a250ed2ef1b.png)

<!-- toc -->

- [Usage](#usage)
- [Commands](#commands)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage
Expand All @@ -27,30 +26,29 @@ $ bear update
# Commands

<!-- commands -->

- [`bear add-file [FILE]`](#bear-add-file-file)
- [`bear add-text [TEXT]`](#bear-add-text-text)
- [`bear archive [ID]`](#bear-archive-id)
- [`bear auth API-TOKEN`](#bear-auth-api-token)
- [`bear autocomplete [SHELL]`](#bear-autocomplete-shell)
- [`bear change-font [FONT]`](#bear-change-font-font)
- [`bear change-theme [THEME]`](#bear-change-theme-theme)
- [`bear commands`](#bear-commands)
- [`bear create [TEXT]`](#bear-create-text)
- [`bear delete-tag [NAME]`](#bear-delete-tag-name)
- [`bear grab-url [URL]`](#bear-grab-url-url)
- [`bear help [COMMAND]`](#bear-help-command)
- [`bear locked [SEARCH]`](#bear-locked-search)
- [`bear open-note [ID]`](#bear-open-note-id)
- [`bear open-tag [NAME]`](#bear-open-tag-name)
- [`bear rename-tag NAME [NEW-NAME]`](#bear-rename-tag-name-new-name)
- [`bear search [TERM]`](#bear-search-term)
- [`bear tags`](#bear-tags)
- [`bear today [SEARCH]`](#bear-today-search)
- [`bear todo [SEARCH]`](#bear-todo-search)
- [`bear trash [ID]`](#bear-trash-id)
- [`bear untagged [SEARCH]`](#bear-untagged-search)
- [`bear update [CHANNEL]`](#bear-update-channel)
* [`bear add-file [FILE]`](#bear-add-file-file)
* [`bear add-text [TEXT]`](#bear-add-text-text)
* [`bear archive [ID]`](#bear-archive-id)
* [`bear auth API-TOKEN`](#bear-auth-api-token)
* [`bear autocomplete [SHELL]`](#bear-autocomplete-shell)
* [`bear change-font [FONT]`](#bear-change-font-font)
* [`bear change-theme [THEME]`](#bear-change-theme-theme)
* [`bear commands`](#bear-commands)
* [`bear create [TEXT]`](#bear-create-text)
* [`bear delete-tag [NAME]`](#bear-delete-tag-name)
* [`bear grab-url [URL]`](#bear-grab-url-url)
* [`bear help [COMMAND]`](#bear-help-command)
* [`bear locked [SEARCH]`](#bear-locked-search)
* [`bear open-note [ID]`](#bear-open-note-id)
* [`bear open-tag [NAME]`](#bear-open-tag-name)
* [`bear rename-tag NAME [NEW-NAME]`](#bear-rename-tag-name-new-name)
* [`bear search [TERM]`](#bear-search-term)
* [`bear tags`](#bear-tags)
* [`bear today [SEARCH]`](#bear-today-search)
* [`bear todo [SEARCH]`](#bear-todo-search)
* [`bear trash [ID]`](#bear-trash-id)
* [`bear untagged [SEARCH]`](#bear-untagged-search)
* [`bear update [CHANNEL]`](#bear-update-channel)

## `bear add-file [FILE]`

Expand Down Expand Up @@ -87,7 +85,7 @@ DESCRIPTION
Returns note's contents.
```

_See code: [src/commands/add-file.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/add-file.ts)_
_See code: [src/commands/add-file.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/add-file.ts)_

## `bear add-text [TEXT]`

Expand Down Expand Up @@ -130,7 +128,7 @@ DESCRIPTION
Returns note's contents.
```

_See code: [src/commands/add-text.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/add-text.ts)_
_See code: [src/commands/add-text.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/add-text.ts)_

## `bear archive [ID]`

Expand All @@ -153,7 +151,7 @@ DESCRIPTION
Encrypted notes can't be accessed with this call.
```

_See code: [src/commands/archive.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/archive.ts)_
_See code: [src/commands/archive.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/archive.ts)_

## `bear auth API-TOKEN`

Expand All @@ -173,7 +171,7 @@ DESCRIPTION
Go to Bear → Help → API Token → Copy Token and paste into this command.
```

_See code: [src/commands/auth.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/auth.ts)_
_See code: [src/commands/auth.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/auth.ts)_

## `bear autocomplete [SHELL]`

Expand Down Expand Up @@ -214,7 +212,7 @@ OPTIONS
-w, --show-window force the opening of bear main window
```

_See code: [src/commands/change-font.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/change-font.ts)_
_See code: [src/commands/change-font.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/change-font.ts)_

## `bear change-theme [THEME]`

Expand All @@ -235,7 +233,7 @@ DESCRIPTION
Some themes may require a Bear Pro subscription.
```

_See code: [src/commands/change-theme.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/change-theme.ts)_
_See code: [src/commands/change-theme.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/change-theme.ts)_

## `bear commands`

Expand Down Expand Up @@ -281,7 +279,7 @@ DESCRIPTION
Returns unique note identifier of new note.
```

_See code: [src/commands/create.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/create.ts)_
_See code: [src/commands/create.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/create.ts)_

## `bear delete-tag [NAME]`

Expand All @@ -303,7 +301,7 @@ DESCRIPTION
If the tag contains any locked note this call will not be performed.
```

_See code: [src/commands/delete-tag.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/delete-tag.ts)_
_See code: [src/commands/delete-tag.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/delete-tag.ts)_

## `bear grab-url [URL]`

Expand All @@ -326,7 +324,7 @@ DESCRIPTION
Returns unique note identifier of new note.
```

_See code: [src/commands/grab-url.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/grab-url.ts)_
_See code: [src/commands/grab-url.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/grab-url.ts)_

## `bear help [COMMAND]`

Expand Down Expand Up @@ -361,7 +359,7 @@ OPTIONS
-w, --show-window force the opening of bear main window
```

_See code: [src/commands/locked.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/locked.ts)_
_See code: [src/commands/locked.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/locked.ts)_

## `bear open-note [ID]`

Expand All @@ -386,12 +384,13 @@ OPTIONS
-u, --header=header note title
-w, --show-window force the opening of bear main window
-x, --exclude-trashed exclude trashed notes
-y, --token=token [default: 493C02-3A08BB-D7BA51] bear api token. defaults to api key provided to auth command.
DESCRIPTION
Returns the matched note's contents.
```

_See code: [src/commands/open-note.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/open-note.ts)_
_See code: [src/commands/open-note.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/open-note.ts)_

## `bear open-tag [NAME]`

Expand All @@ -405,13 +404,14 @@ ARGUMENTS
NAME tag name
OPTIONS
-h, --help show CLI help
-h, --help show CLI help
-y, --token=token [default: 493C02-3A08BB-D7BA51] bear api token. defaults to api key provided to auth command.
DESCRIPTION
Returns list of unique note identifiers and note titles.
```

_See code: [src/commands/open-tag.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/open-tag.ts)_
_See code: [src/commands/open-tag.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/open-tag.ts)_

## `bear rename-tag NAME [NEW-NAME]`

Expand All @@ -434,7 +434,7 @@ DESCRIPTION
If the tag contains any locked note this call will not be performed.
```

_See code: [src/commands/rename-tag.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/rename-tag.ts)_
_See code: [src/commands/rename-tag.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/rename-tag.ts)_

## `bear search [TERM]`

Expand All @@ -451,12 +451,13 @@ OPTIONS
-h, --help show CLI help
-t, --tag=tag tag to search into
-w, --show-window force the opening of bear main window
-y, --token=token [default: 493C02-3A08BB-D7BA51] bear api token. defaults to api key provided to auth command.
DESCRIPTION
Returns list of unique note identifiers and note titles.
```

_See code: [src/commands/search.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/search.ts)_
_See code: [src/commands/search.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/search.ts)_

## `bear tags`

Expand All @@ -467,13 +468,16 @@ USAGE
$ bear tags
OPTIONS
-h, --help show CLI help
-h, --help show CLI help
-y, --token=token (required) [default: 493C02-3A08BB-D7BA51] bear api token. defaults to api key provided to auth
command.
DESCRIPTION
Returns list of tag names.
```

_See code: [src/commands/tags.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/tags.ts)_
_See code: [src/commands/tags.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/tags.ts)_

## `bear today [SEARCH]`

Expand All @@ -489,6 +493,7 @@ ARGUMENTS
OPTIONS
-h, --help show CLI help
-w, --show-window force the opening of bear main window
-y, --token=token [default: 493C02-3A08BB-D7BA51] bear api token. defaults to api key provided to auth command.
DESCRIPTION
Returns list of unique note identifiers and note titles.
Expand All @@ -497,7 +502,7 @@ DESCRIPTION
BUG: There's an issue where fetching Today's notes causes bear to hold process open.
```

_See code: [src/commands/today.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/today.ts)_
_See code: [src/commands/today.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/today.ts)_

## `bear todo [SEARCH]`

Expand All @@ -513,13 +518,14 @@ ARGUMENTS
OPTIONS
-h, --help show CLI help
-w, --show-window force the opening of bear main window
-y, --tokne=tokne [default: 493C02-3A08BB-D7BA51] bear api token. defaults to api key provided to auth command.
DESCRIPTION
Returns list of unique note identifiers and note titles.
BUG: There's an issue with bear that causes notes that match search with no Todo's to be returned.
```

_See code: [src/commands/todo.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/todo.ts)_
_See code: [src/commands/todo.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/todo.ts)_

## `bear trash [ID]`

Expand All @@ -542,7 +548,7 @@ DESCRIPTION
Encrypted notes can't be used with this call.
```

_See code: [src/commands/trash.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/trash.ts)_
_See code: [src/commands/trash.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/trash.ts)_

## `bear untagged [SEARCH]`

Expand All @@ -558,12 +564,13 @@ ARGUMENTS
OPTIONS
-h, --help show CLI help
-w, --show-window force the opening of bear main window
-y, --token=token [default: 493C02-3A08BB-D7BA51] bear api token. defaults to api key provided to auth command.
DESCRIPTION
Returns list of unique note identifiers and note titles.
```

_See code: [src/commands/untagged.ts](https://github.com/sloansparger/bear/blob/v0.1.0/src/commands/untagged.ts)_
_See code: [src/commands/untagged.ts](https://github.com/sloansparger/bear/blob/v0.1.1/src/commands/untagged.ts)_

## `bear update [CHANNEL]`

Expand All @@ -575,5 +582,4 @@ USAGE
```

_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v1.3.10/src/commands/update.ts)_

<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@sloansparger/bear",
"description": "Unofficial CLI for the Bear notes app (MacOS only)",
"version": "0.1.0",
"version": "0.1.1",
"author": "Sloan Sparger @sloansparger",
"license": "MIT",
"repository": "sloansparger/bear",
Expand Down

0 comments on commit 73f0ac4

Please sign in to comment.