An open API service indexing awesome lists of open source software.

https://github.com/rioverse/anki-ls

Inspect Anki export files (.apkg) with this CLI application.
https://github.com/rioverse/anki-ls

anki cli json language-learning spaced-repetition srs

Last synced: 10 months ago
JSON representation

Inspect Anki export files (.apkg) with this CLI application.

Awesome Lists containing this project

README

          

# anki-ls

Inspect Anki export files (.apkg) using the `anki-ls` CLI application. Returns the flashcard data as JSON.

## Run Binary

Download the executable for Linux/x86 and run:

```bash
./anki-ls [anki-export-file]
```

The `anki-export-file` is the Anki file you have exported from Anki (file name ending: .apkg).

The `type` parameter is one of the following values:
- decks - Display the decks
- notes - Display the notes
- cards - Display the cards
- noteTypes - Display the note types
- reviews - Display the reviews
- config - Display the config
- stats - Display file statistics

## Install Dependencies

Anki-ls uses Bun.

To install dependencies:

```bash
bun install
```

## Build binary

```bash
bun build index.ts --compile --outfile anki-ls
```

## References

Thanks a lot to Eiko for his great [`srs-converter`](https://github.com/eikowagenknecht/srs-converter) library.

## License

MIT License