Skip to content

albertc9/Lilith

Repository files navigation

English 简体中文 繁體中文 Español Français हिन्दी

Lilith: English Practicing Workflow

Lilith is an integrated workflow designed to streamline vocabulary acquisition and reading comprehension for IELTS and TOEFL preparation. It can also be used as an efficient daily work tool, helping you record new words seamlessly without dragging you away from your reading or work.

The core loop operates as follows:

Context: Practice reading and listening using the IELTSbro (雅思哥) desktop app, other web applications, or any general work environment.

Capture: Highlight unfamiliar terms and use a custom PopClip script to query dictionaries (Merriam-Webster, Wordnik, DictionaryAPI) and automatically format an Anki flashcard. The base form (e.g., apples -> apple), definition, example, and source are automatically populated in the flashcard.

Retention: Push the flashcard directly to Anki and sync it with AnkiMobile. You can quickly review and print your vocabulary later.

By following this process, users can seamlessly look up definitions, create flashcards with a single click, and conveniently sync across multiple devices for daily review using the Ebbinghaus memory method.


Important Notice Lilith is free and open-source, as are most of the underlying tools. However, a PopClip license is required. Its text-selection engine is essential for routing content to Anki and the dictionary APIs. Therefore, you must purchase PopClip (starting at $12) to use Lilith. You can use PopClip for free 250 times before deciding whether to buy it. You’re sure to find it’s well worth the money!

Anki for macOS is also free and open-source. However, if you would like to review flashcards on your iPhone or iPad, purchasing the AnkiMobile app from the App Store is required.

Lilith is only supported on macOS.


Usage Examples

  1. Select a word and use your configured shortcut (e.g., cmd+1): i14
  2. Click 'Lilith': i15
  3. Click Add.

Done! The new card containing the definition, example, and word is now successfully saved to your deck.

When you are ready to study:

  1. Click the 'Vocab' deck: i19
  2. Start studying! i16 i17
  3. You can configure Anki to utilize the Ebbinghaus memory method: i20 i18
  4. Note that AnkiMobile offers a more convenient review experience than Anki for macOS! i21

Prerequisites and Installation

  1. (Optional) Download and install the DeepL macOS application. This tool is free, accurate, and convenient. While not strictly essential for Lilith, it is highly recommended. With the app running in the background, a single cmd+C+C instantly translates selected text.
  2. Purchase, download, and install PopClip. A Standard License ($12) is sufficient, though a Lifetime License ($26) is also available.
  3. Download and install Anki. It is completely free.
  4. API Keys: The PopClip script relies on external APIs to fetch definitions and examples.
    1. Merriam-Webster Learner's Dictionary API (Required): Obtain a free key from the M-W Developer portal. Follow the "Get Started Using Our API" instructions and apply for a "Learner's API Key." M-W provides excellent definitions and examples for over 100,000 words, including idioms and common phrases.
    2. Wordnik API (Optional but recommended): This acts as a reliable fallback. Obtain a free personal use key from Wordnik.
    3. Built-in Fallback APIs: Lilith includes default APIs that do not require manual registration. However, these provide lower-quality results and should only be relied upon as a last resort.
  5. (Optional) AnkiMobile Flashcards: While Anki for macOS is free, you may prefer reviewing on a mobile device. The AnkiMobile Flashcards app for iOS is highly recommended for convenience, though it requires a one-time purchase of $24.99.

Once you have these components, you are ready to configure Lilith and reduce vocabulary capture to a single click.


System Configuration

DeepL Shortcut Setup (Optional)

As mentioned, DeepL is optional but strongly recommended. It provides immediate translation without breaking your reading flow in IELTSbro or other applications. While there may be minor UI quirks on macOS, the shortcut translation is highly reliable once the app is running.

Click the gear icon on the top-right to open settings. Navigate to 'Keyboard shortcuts' to view or change the shortcut for 'Translate selected text'.

i1

i2

i3

This convenient shortcut provides professional translations simply by pressing cmd+C+C.

i4

Anki and AnkiConnect Setup

The PopClip script communicates with Anki via a local HTTP server. You must install the AnkiConnect add-on first:

  1. Open Anki.
  2. Navigate to Tools -> Add-ons -> Get Add-ons. i5 i6
  3. Input the code: 2055492159. More information is available on the AnkiConnect page.
  4. Restart Anki.

Next, configure the Anki database:

  1. Create a Deck named exactly: Vocab
  2. Create a Note Type named exactly: vocab i7
  3. Ensure the vocab Note Type contains exactly these fields in this specific order:
    1. Word
    2. Meaning
    3. Example
    4. Source
    5. Add Reverse i8
  4. Open the 'Cards...' menu and configure the templates exactly as shown below:

Card 1: Front Template:

{{Word}}

Back Template:

{{FrontSide}}
<hr id=answer>
<div>{{Meaning}}</div>

{{#Example}}
<br>
<div>{{Example}}</div>
{{/Example}}

{{#Source}}
<br>
<small>{{Source}}</small>
{{/Source}}

Styling:

.card {
    font-family: arial;
    font-size: 20px;
    line-height: 1.5;
    text-align: center;
    color: black;
    background-color: white;
}

Card 2: Front Template:

{{#Add Reverse}}
{{Meaning}}
{{/Add Reverse}}

Back Template:

{{#Add Reverse}}
{{FrontSide}}
<hr id=answer>
<div>{{Word}}</div>

{{#Example}}
<br>
<div>{{Example}}</div>
{{/Example}}
{{/Add Reverse}}

Styling:

.card {
    font-family: arial;
    font-size: 20px;
    line-height: 1.5;
    text-align: center;
    color: black;
    background-color: white;
}

PopClip Script Installation

Download the newest release of Lilith. Extract the archive and locate the file named Lilith.popcliptxt.

Double-click the file and click 'Install "Lilith"':

Enter the API keys for the Merriam-Webster Dictionary and Wordnik as obtained earlier:

Finally, configure a keyboard shortcut for PopClip (e.g., cmd+1):

You're All Set! Your Lilith workflow is now ready to use.


Troubleshooting

  • "Connection Failed" Error from PopClip: Ensure the Anki desktop application is currently running. AnkiConnect only exposes the local server while the application is active.
  • "AnkiConnect Rejected It" Error: Verify that your deck is named exactly Vocab and your Note Type is exactly vocab, containing the exact five fields listed in the configuration steps. AnkiConnect requires strict structural alignment to format the payload correctly.

License

Lilith is licensed under the MIT License. See the LICENSE file for details.

Others

Please refer to the English version.


About

Lilith: English Practicing Workflow

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages