Skip to content

docs: add a note for macos users to get rid of anki connection errors #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thelazyoxymoron wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add a note for macos users to get rid of anki connection errors #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions substudy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,27 @@ substudy export tracks episode_01_01.mkv episode_01_01.es.srt
substudy --help
```

### Note for MacOS users
MacOS users might get the following error when running `substudy export anki ...`:
```
Error: Could not connect to Anki-Connect

Caused by:
0: error sending request for url (http://localhost:8765/): connection error: Connection reset by peer (os error 54)
1: connection error: Connection reset by peer (os error 54)
2: Connection reset by peer (os error 54)
```

If you face this error, make sure to disable "App Nap" for Anki. Execute the following commands in a
terminal window and restart Anki:
```
defaults write net.ankiweb.dtop NSAppSleepDisabled -bool true
defaults write net.ichi2.anki NSAppSleepDisabled -bool true
defaults write org.qt-project.Qt.QtWebEngineCore NSAppSleepDisabled -bool true
```

[Reference here](https://foosoft.net/projects/anki-connect/#:~:text=Notes%20for%20MacOS%20Users)

## Prerequisites

You will need to know some command-line basics: How to open your terminal, how to install command-line tools, how to configure you `PATH`, how to change directories, and how to set environment variables. But you shouldn't need much more than that, because `substudy` is designed to be a friendly command-line tool, as such things go.
Expand Down