diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 4d02602..7389799 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,4 +1,4 @@ { "packages/core": "0.10.4", - "packages/cli": "0.6.3" + "packages/cli": "0.6.4" } diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index 4c3eb10..2b7c3cb 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [0.6.4](https://github.com/timgreen/Anki.md/compare/cli/v0.6.3...cli/v0.6.4) (2023-03-12) + +### Features + +- **connect:** FindNotes ([2e00764](https://github.com/timgreen/Anki.md/commit/2e0076477ab7e1b877833558e293cef81cbbd21d)) +- **connect:** NotesInfo ([10178a3](https://github.com/timgreen/Anki.md/commit/10178a36dc6c0f8d9e2c6bc8b6ff8446f0fa78bc)) + ## [0.6.3](https://github.com/timgreen/Anki.md/compare/cli/v0.6.2...cli/v0.6.3) (2023-03-12) ### Features diff --git a/packages/cli/README.md b/packages/cli/README.md index 9e51bb1..35a89bd 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -16,7 +16,7 @@ $ npm install -g @anki.md/cli $ ankimd COMMAND running command... $ ankimd (--version) -@anki.md/cli/0.6.3 linux-x64 node-v18.14.2 +@anki.md/cli/0.6.4 linux-x64 node-v18.14.2 $ ankimd --help [COMMAND] USAGE $ ankimd COMMAND @@ -31,9 +31,11 @@ USAGE - [`ankimd autocomplete [SHELL]`](#ankimd-autocomplete-shell) - [`ankimd connect deckNames`](#ankimd-connect-decknames) +- [`ankimd connect findNotes QUERY`](#ankimd-connect-findnotes-query) - [`ankimd connect getMediaFilesNames [PATTERN]`](#ankimd-connect-getmediafilesnames-pattern) - [`ankimd connect getProfiles`](#ankimd-connect-getprofiles) - [`ankimd connect loadProfile NAME`](#ankimd-connect-loadprofile-name) +- [`ankimd connect notesInfo NOTEIDS`](#ankimd-connect-notesinfo-noteids) - [`ankimd connect sync`](#ankimd-connect-sync) - [`ankimd help [COMMANDS]`](#ankimd-help-commands) - [`ankimd rmids FILES`](#ankimd-rmids-files) @@ -86,6 +88,29 @@ EXAMPLES $ ankimd connect deckNames ``` +## `ankimd connect findNotes QUERY` + +Returns an array of note IDs for a given query. + +``` +USAGE + $ ankimd connect findNotes QUERY [--json] + +ARGUMENTS + QUERY Query syntax: https://docs.ankiweb.net/searching.html. + +GLOBAL FLAGS + --json Format output as json. + +DESCRIPTION + Returns an array of note IDs for a given query. + +EXAMPLES + $ ankimd connect findNotes findNotes deck:current + + $ ankimd connect findNotes findNotes 'deck:"a b"' +``` + ## `ankimd connect getMediaFilesNames [PATTERN]` Gets the names of media files matched the pattern. Returning all names by default. @@ -145,6 +170,27 @@ EXAMPLES $ ankimd connect loadProfile profile1 ``` +## `ankimd connect notesInfo NOTEIDS` + +Returns a list of objects containing for each note ID the note fields, tags, note type and the cards belonging to the note. + +``` +USAGE + $ ankimd connect notesInfo NOTEIDS [--json] + +GLOBAL FLAGS + --json Format output as json. + +DESCRIPTION + Returns a list of objects containing for each note ID the note fields, tags, note type and the cards belonging to the + note. + +EXAMPLES + $ ankimd connect notesInfo notesInfo 123 + + $ ankimd connect notesInfo notesInfo 123 456 +``` + ## `ankimd connect sync` Synchronizes the local Anki collections with AnkiWeb. @@ -200,7 +246,7 @@ EXAMPLES $ ankimd rmids deckA.md deckB.md ``` -_See code: [dist/commands/rmids.ts](https://github.com/timgreen/Anki.md/blob/cli/v0.6.3/packages/cli/src/commands/rmids.ts)_ +_See code: [dist/commands/rmids.ts](https://github.com/timgreen/Anki.md/blob/cli/v0.6.4/packages/cli/src/commands/rmids.ts)_ ## `ankimd sync MARKDOWNS` @@ -234,6 +280,6 @@ EXAMPLES $ ankimd sync deckA.md https://example.com/foo/deckB.md ``` -_See code: [dist/commands/sync.ts](https://github.com/timgreen/Anki.md/blob/cli/v0.6.3/packages/cli/src/commands/sync.ts)_ +_See code: [dist/commands/sync.ts](https://github.com/timgreen/Anki.md/blob/cli/v0.6.4/packages/cli/src/commands/sync.ts)_ diff --git a/packages/cli/package.json b/packages/cli/package.json index f6aa1ac..90e646d 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "@anki.md/cli", - "version": "0.6.3", + "version": "0.6.4", "description": "Anki.md CLI.", "author": " @timgreen", "bin": {