Commands

Tree

The command tree (made with this):

lingq             - Lingq command line scripts.
├── get           - Get commands.
│   ├── courses   - Get all courses for the given languages.
│   ├── images    - Get course images.
│   ├── lesson    - Get a lesson from a lesson id.
│   ├── lessons   - Get all lessons from a course id.
│   └── words     - Get all words (LingQs) for the given languages.
├── make          - Make commands.
│   ├── markdown  - Make markdown files for the given languages.
│   ├── overview  - Make a library overview.
│   └── yomitan   - Make a Yomitan dictionary from the result of 'lingq get words'.
├── merge         - Merge two courses.
├── patch         - Patch commands.
│   └── audios    - Patch a course audio.
├── post          - Upload lessons.
├── postyt        - Post a youtube playlist.
├── reindex       - Reindex course titles.
├── replace       - Replace words in a course.
├── resplit       - Resplit a course.
├── setup         - Create or update a config file with your LingQ API key.
├── show          - Show commands.
│   ├── course    - Show lessons in a language.
│   ├── my        - Show my collections in a language.
│   ├── stats     - Show stats.
│   └── status    - Show pending and refused lessons in a language.
├── sort          - Sort course lessons.
└── timestamp     - Add course timestamps.

lingq

Lingq command line scripts.

See more details about a command with the --help flag.

Usage:

lingq [OPTIONS] COMMAND [ARGS]...

Options:

  --version   Show the version and exit.
  -h, --help  Show this message and exit.

lingq get

Get commands.

Usage:

lingq get [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

lingq get courses

Get all courses for the given languages.

CAREFUL: This reorders your 'Continue studying' shelf.

If no language codes are given, use all languages.

Usage:

lingq get courses [OPTIONS] [LANGS]...

Options:

  -o, --opath PATH          Output path.  [default: downloads]
  --download-audio          Also download audio.
  --download-timestamps     Also download timestamps.
  -s, --skip-downloaded     Skip already downloaded lessons.
  -b, --batch-size INTEGER  Number of courses to download simultanously.
                            Increasing this too much may incur in throttling.
                            Suggested: 1 or 2.  [default: 1]
  -y, --yes                 Automatic yes to prompts.
  -h, --help                Show this message and exit.

lingq get images

Get course images.

Usage:

lingq get images [OPTIONS] LANG COURSE_ID

Options:

  -o, --opath PATH  Output path.  [default: downloads]
  -h, --help        Show this message and exit.

lingq get lesson

Get a lesson from a lesson id.

CAREFUL: This reorders your 'Continue studying' shelf.

Usage:

lingq get lesson [OPTIONS] LANG LESSON_ID

Options:

  -o, --opath PATH       Output path.  [default: downloads]
  --download-audio       Also download audio.
  --download-timestamps  Also download timestamps.
  -h, --help             Show this message and exit.

lingq get lessons

Get all lessons from a course id.

CAREFUL: This reorders your 'Continue studying' shelf.

Usage:

lingq get lessons [OPTIONS] LANG COURSE_ID

Options:

  -o, --opath PATH       Output path.  [default: downloads]
  --download-audio       Also download audio.
  --download-timestamps  Also download timestamps.
  -s, --skip-downloaded  Skip already downloaded lessons.
  --with-index           Add index to the title.
  -h, --help             Show this message and exit.

lingq get words

Get all words (LingQs) for the given languages.

If no language codes are given, use all languages.

Usage:

lingq get words [OPTIONS] [LANGS]...

Options:

  -o, --opath PATH  Output path.  [default: downloads]
  -h, --help        Show this message and exit.

lingq make

Make commands.

Usage:

lingq make [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

lingq make markdown

Make markdown files for the given languages.

If no language codes are given, use all languages.

Usage:

lingq make markdown [OPTIONS] [LANGS]...

Options:

  -o, --opath PATH                Output path.  [default: downloads]
  --select-courses [all|mine|shared]
                                  Select which courses to include.  [default:
                                  all]
  --include-views                 Include the number of views in the markdown.
  -h, --help                      Show this message and exit.

lingq make overview

Make a library overview.

Usage:

lingq make overview [OPTIONS] LANG

Options:

  -h, --help  Show this message and exit.

lingq make yomitan

Make a Yomitan dictionary from the result of 'lingq get words'.

If no language codes are given, use all languages.

Usage:

lingq make yomitan [OPTIONS] {simple|normal} [LANGS]...

Options:

  -i, --ipath PATH  Input path.  [default: downloads/lingqs]
  -h, --help        Show this message and exit.

lingq merge

Merge two courses.

Moves all the lessons from course FR to course TO.

The old course, even if it remains without any lessons, will not be deleted.

Usage:

lingq merge [OPTIONS] LANG FR_COURSE_ID TO_COURSE_ID

Options:

  -h, --help  Show this message and exit.

lingq patch

Patch commands.

Usage:

lingq patch [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

lingq patch audios

Patch a course audio.

Usage:

lingq patch audios [OPTIONS] [LANGS]... COURSE_ID

Options:

  -a, --audios-folder PATH  Audios folder path.
  -h, --help                Show this message and exit.

lingq post

Upload lessons.

When no texts are given, LingQ will use whisper to transcribe.

Usage:

lingq post [OPTIONS] LANG COURSE_ID

Options:

  -t, --texts-folder PATH         Texts folder path.
  -a, --audios-folder PATH        Audios folder path.
  --pairing-strategy [zip|zipsort|exact|fuzzy]
                                  [default: fuzzy]
  -h, --help                      Show this message and exit.

lingq postyt

Post a youtube playlist.

Usage:

lingq postyt [OPTIONS] LANG COURSE_ID PLAYLIST_URL

Options:

  --skip-uploaded BOOLEAN  [default: True]
  -h, --help               Show this message and exit.

lingq reindex

Reindex course titles.

Usage:

lingq reindex [OPTIONS] LANG COURSE_ID

Options:

  -n, --dry-run  Show what would change without modifying anything.
  -h, --help     Show this message and exit.

lingq replace

Replace words in a course.

Example (replace a with b): lingq replace ja 123123 a b

Usage:

lingq replace [OPTIONS] LANG COURSE_ID FR TO

Options:

  -y, --yes   Automatic yes to prompts.
  -h, --help  Show this message and exit.

lingq resplit

Resplit a course.

Usage:

lingq resplit [OPTIONS] LANG COURSE_ID

Options:

  -h, --help  Show this message and exit.

lingq setup

Create or update a config file with your LingQ API key.

You can find your API key at: https://www.lingq.com/accounts/apikey/

Usage:

lingq setup [OPTIONS] APIKEY

Options:

  -h, --help  Show this message and exit.

lingq show

Show commands.

Usage:

lingq show [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

lingq show course

Show lessons in a language.

Usage:

lingq show course [OPTIONS] LANG COURSE_ID

Options:

  -s, --shared
  -c, --codes
  -v, --verbose
  -h, --help     Show this message and exit.

lingq show my

Show my collections in a language.

Usage:

lingq show my [OPTIONS] LANG

Options:

  -s, --shared
  -c, --codes
  -v, --verbose
  -h, --help     Show this message and exit.

lingq show stats

Show stats.

Usage:

lingq show stats [OPTIONS] LANG

Options:

  -h, --help  Show this message and exit.

lingq show status

Show pending and refused lessons in a language.

Usage:

lingq show status [OPTIONS] LANG

Options:

  -h, --help  Show this message and exit.

lingq sort

Sort course lessons.

Usage:

lingq sort [OPTIONS] LANG COURSE_ID

Options:

  -n, --dry-run  Show what would change without modifying anything.
  -h, --help     Show this message and exit.

lingq timestamp

Add course timestamps.

Usage:

lingq timestamp [OPTIONS] LANG COURSE_ID

Options:

  --skip-timestamped BOOLEAN
  -h, --help                  Show this message and exit.