Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/MarcusXavierr/anki-helper

A tool to make life easier for those who use anki as part of learning new languages
https://github.com/MarcusXavierr/anki-helper

cli golang tui

Last synced: 3 months ago
JSON representation

A tool to make life easier for those who use anki as part of learning new languages

Host: GitHub
URL: https://github.com/MarcusXavierr/anki-helper
Owner: MarcusXavierr
License: apache-2.0
Created: 2022-08-11T02:25:14.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-03-07T23:02:25.000Z (over 1 year ago)
Last Synced: 2024-02-17T09:36:43.379Z (9 months ago)
Topics: cli, golang, tui
Language: Go
Homepage:
Size: 143 KB
Stars: 16
Watchers: 1
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Anki Helper
![gopher](https://user-images.githubusercontent.com/59923581/223569450-e039400f-4ede-4171-8e6e-ee4252cfb15b.gif)

[![Go Report Card](https://goreportcard.com/badge/github.com/MarcusXavierr/anki-helper)](https://goreportcard.com/report/github.com/MarcusXavierr/anki-helper)
![example workflow](https://github.com/MarcusXavierr/anki-helper/actions/workflows/go.yml/badge.svg)

Anki Helper is a simple command line tool that can help you learn and memorize new words and phrases using Anki.
With just a few simple steps, you can set up Anki Helper to automatically create flashcards from new words you encounter while reading or listening to English.

These flashcards will then be added to your Anki deck for review later. New languages will be supported soon

[Usage Examples](#usage-examples) •
[Installation](#installation) •
[Getting Startd](#getting-started) •
[Usage](#usage)

## Usage Examples

### Insert flashcards on anki

https://user-images.githubusercontent.com/59923581/223573058-cb580c40-e556-45ce-9f58-001bfbdc7342.mp4

### Get sentence definitions

![definition](https://user-images.githubusercontent.com/59923581/220511647-44ac85d3-a1cc-4eef-ae78-114f41dc45b8.gif)

### Add new sentences to further practice

![add](https://user-images.githubusercontent.com/59923581/220512928-f4a311f8-256c-4af0-8e98-279b7775fb88.gif)

## Installation

### go install
you can install this project with go
```bash
go install github.com/MarcusXavierr/anki-helper@latest
```
### Binaries
You can also install a compiled binary to your machine and then put it in your shell path.

Go to the [releases page](https://github.com/MarcusXavierr/anki-helper/releases) and choose the option that best fits your environment.

## Getting Started
To get started, visit the [project's wiki](https://github.com/MarcusXavierr/anki-helper/wiki). There you will find instructions on how to set up your Anki and how to configure Anki-helper, in a simple and fast way.

## Usage

### Insert flashcards on anki
You can easilly insert flashcards on anki using anki-helper.
```bash
anki-helper ankiInsert

# Or if you want to specify how many flashcards you wanna insert on anki, use the -i flag

anki-helper ankiInsert -i 10
```

### Add word to further practice
You can run this command to `add` a word to your track file

```bash
anki-helper add 'sentence'
```
### Get definition
you can also use the command `dictionary` to get the definitions of a sentence (works for words and phrasal verbs)

```bash
anki-helper dictionary 'sentence'
```