Files
zed/docs/src/repl.md
T
Nate Butler fa3d29087d Add REPL dropdown menu to toolbar (#14493)
TODO: 


- [x] Actions run from menu not firing
- [x] Menu differentiates idle and busy for running kernel

Menu States:
- [x] No session && no support known

No session && no kernel installed for languages of known support
- (TODO after) Intro to REPL
- [x] Link to docs

No session but can start one
- [x] Start REPL
- (TODO after) More info -> Docs?

Yes Session

- [x] Info: Kernel name, language
  example: chatlab-3.7-adsf87fsa (Python)
  example: condapy-3.7 (Python)
- [x] Change Kernel -> https://zed.dev/docs/repl#change-kernel
- ---
- [x] Run
- [x] Interrupt
- [x] Clear Outputs
- ---
- [x] Shutdown


(Release notes left empty as the change will be documented in the REPL
release!)

Reserved for a follow on PR:

```
- [ ] Status should update when the menu is open (missing `cx.notify`?)
- [ ] Shutdown all kernels action
- [ ] Restart action
- [ ] [Default kernel changed - restart (this kernel) to apply] // todo!(kyle): need some kind of state thing that says if this has happened
```


Release Notes:

- N/A

---------

Co-authored-by: Marshall Bowers <elliott.codes@gmail.com>
Co-authored-by: Kyle Kelley <rgbkrk@gmail.com>
Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com>
2024-07-15 11:55:49 -07:00

2.8 KiB

REPL

Read. Eval. Print. Loop.

This feature is in active development. Details may change. We're delighted to get feedback as the REPL feature evolves.

Getting started

Bring the power of Jupyter kernels to your editor! The built-in REPL for Zed allows you to run code interactively in your editor similarly to a notebook with your own text files.

To start using the REPL, add the following to your Zed settings.json:

{
  "jupyter": {
    "enabled": true
  }
}

Installation

Zed supports running code in multiple languages. To get started, you need to install a kernel for the language you want to use.

Currently supported languages:

Once installed, you can start using the REPL in the respective language files, or other places those languages are supported, such as Markdown.

Using the REPL

To start the REPL, open a file with the language you want to use and use the repl: run command (defaults to CMD + Enter on macOS). You can also click on the REPL icon in the toolbar.

The repl: run command will be executed on your selection(s), and the result will be displayed below the selection.

Outputs can be cleared with the repl: clear outputs command, or from the REPL menu in the toolbar.

Changing Kernels

Work in Progress!

Language specific instructions

Python

Global environment

On MacOS, your system Python will not work. Either set up pyenv or use a virtual environment.

To setup your current python to have an available kernel, run:

pip install ipykernel
python -m ipykernel install --user

Conda Environment

source activate myenv
conda install ipykernel
python -m ipykernel install --user --name myenv --display-name "Python (myenv)"

Virtualenv with pip

source activate myenv
pip install ipykernel
python -m ipykernel install --user --name myenv --display-name "Python (myenv)"

Typescript: Deno

Install Deno and then install the Deno jupyter kernel:

deno jupyter --unstable --install

Other languages

The following languages and kernels are also supported. You can help us out by expanding their installation instructions and configuration: