Skip to content

Latest commit

 

History

History

cli

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
bin
bin
 
 
src
src
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.mocharc.json
.mocharc.json
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

@anki.md/cli

oclif Version main License

@anki.md CLI ankimd.

Usage

$ npm install -g @anki.md/cli
$ ankimd COMMAND
running command...
$ ankimd (--version)
@anki.md/cli/0.7.2 linux-x64 node-v18.16.1
$ ankimd --help [COMMAND]
USAGE
  $ ankimd COMMAND
...

Commands

ankimd autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ ankimd autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

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

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ ankimd autocomplete

  $ ankimd autocomplete bash

  $ ankimd autocomplete zsh

  $ ankimd autocomplete powershell

  $ ankimd autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

ankimd connect deckNames

Gets the complete list of deck names for the current user.

USAGE
  $ ankimd connect deckNames [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Gets the complete list of deck names for the current user.

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.

USAGE
  $ ankimd connect getMediaFilesNames [PATTERN] [--json]

ARGUMENTS
  PATTERN  Pattern

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Gets the names of media files matched the pattern. Returning all names by default.

EXAMPLES
  $ ankimd connect getMediaFilesNames getMediaFilesNames

  $ ankimd connect getMediaFilesNames getMediaFilesNames pattern

ankimd connect getProfiles

Retrieve the list of profiles.

USAGE
  $ ankimd connect getProfiles [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Retrieve the list of profiles.

EXAMPLES
  $ ankimd connect getProfiles

ankimd connect loadProfile NAME

Selects the profile specified in request.

USAGE
  $ ankimd connect loadProfile NAME

ARGUMENTS
  NAME  Profile name

DESCRIPTION
  Selects the profile specified in request.

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.

USAGE
  $ ankimd connect sync

DESCRIPTION
  Synchronizes the local Anki collections with AnkiWeb.

EXAMPLES
  $ ankimd connect sync

ankimd help [COMMANDS]

Display help for ankimd.

USAGE
  $ ankimd help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for ankimd.

See code: @oclif/plugin-help

ankimd sync MARKDOWNS

Sync to Anki Desktop via AnkiConnect.

USAGE
  $ ankimd sync MARKDOWNS [--math native|svg] [--update-model-templates] [--update-model-styling]
    [--overwrite-existing-medias]

ARGUMENTS
  MARKDOWNS  Markdown files

FLAGS
  --math=<option>              [default: native] render math equations as SVG or use Anki native mathjax support.
                               <options: native|svg>
  --overwrite-existing-medias  Replace the existing medias with the same name during sync.
  --update-model-styling       update the styling for the existing note models.
  --update-model-templates     update the card templates for the existing note models.

DESCRIPTION
  Sync to Anki Desktop via AnkiConnect.

EXAMPLES
  $ ankimd sync deckA.md

  $ ankimd sync deckA.md deckB.md

  $ ankimd sync deckA.md https://example.com/foo/deckB.md

See code: dist/commands/sync.ts