diff --git a/README.md b/README.md index f04a82c..ece8a3a 100644 --- a/README.md +++ b/README.md @@ -342,6 +342,16 @@ You can sync multiple files at the same time. Simple run `:JupyniumStartSync` ag You can run `:JupyniumStartSync` on a new Neovim instance. If you have `auto_attach_to_server = false` during setup, you need to run `:JupyniumAttachToServer` and `:JupyniumStartSync`. +#### Connect to remote kernel + +Jupyter opens a kernel for every notebook, you are actually maniputating the kernel when you sync with notebook + +So you can also connect to this kernel using frontends other than the notebook. To establish a connection to the kernel, run `:JupyniumKernelOpenInTerminal`. + +If the kernel is running on a remote server, use `:JupyniumKernelOpenInTerminal user@host` , this command uses SSH to connect. + +Which kernel you connect to depends on which notebook your neovim is synced with. If it is not synchronized with any notebook, you will connect to the most recently created kernel. + ## 📝 Jupynium file format (.ju.py or .ju.\*) The Jupynium file format follows Jupytext's percent format. In order for Jupynium to detect the files, name them as `*.ju.py` or specify `jupynium_file_pattern` in `require("jupynium").setup()`.