https://jasongrout.github.io/medium-archive/pelican/2024-11-13T19:37:00+00:00The Project Jupyter blog: news, releases, and community stories, archived from blog.jupyter.org.2024-11-13T19:37:00+00:002024-11-13T19:37:00+00:00Ian Thomastag:jasongrout.github.io,2024-11-13:/medium-archive/pelican/posts/2024/jupyterlite-terminal/

<p>JupyterLite is an unofficial Jupyter distribution that runs entirely in the web browser without any server components. Deployment and…</p>

<p><img src="https://jasongrout.github.io/medium-archive/pelican/posts/2024/jupyterlite-terminal/images/001-1_OSnVBpfV12C1YpgVnuXOyw.webp" alt="" loading="lazy" data-body-image=""></p> <p><a href="https://jupyterlite.readthedocs.io/en/stable/">JupyterLite</a> is an unofficial Jupyter distribution that runs entirely in the web browser without any server components. Deployment and hosting are easy as JupyterLite sites are just static websites.</p> <p>JupyterLite isn’t yet as fully-featured as the more established JupyterLab and developers are always looking for ways to add new features to bridge that gap. <a href="https://quantstack.net/">QuantStack</a> are therefore delighted to announce that we have been working on a new Terminal for JupyterLite.</p> <h2 id="how-do-you-try-out-the-jupyterlite-terminal">How do you try out the JupyterLite Terminal?</h2> <p>Go to <a href="https://jupyterlite-terminal.vercel.app/">https://jupyterlite-terminal.vercel.app/</a> and click on the Terminal launcher.</p> <h2 id="what-can-you-do-with-the-jupyterlite-terminal">What can you do with the JupyterLite Terminal?</h2> <ul> <li>Run shell commands such as <code>ls</code> and <code>cat</code> on the same file system as the rest of JupyterLite:</li> </ul> <p><img src="https://jasongrout.github.io/medium-archive/pelican/posts/2024/jupyterlite-terminal/images/002-1_dkyeiiagy9zZnfCxjkCgPg.mp4" alt="" loading="lazy" data-body-image=""></p> <ul> <li>Use tab completion of command and file names, and pipes between commands:</li> </ul> <p><img src="https://jasongrout.github.io/medium-archive/pelican/posts/2024/jupyterlite-terminal/images/003-1_wTGFO6IDHQ0YSYjso-XUtA.mp4" alt="" loading="lazy" data-body-image=""></p> <ul> <li>Store and use the command history:</li> </ul> <p><img src="https://jasongrout.github.io/medium-archive/pelican/posts/2024/jupyterlite-terminal/images/004-1_qFCSqPLAJptGXf4fCC7F0g.mp4" alt="" loading="lazy" data-body-image=""></p> <ul> <li>Change the theme settings:</li> </ul> <p><img src="https://jasongrout.github.io/medium-archive/pelican/posts/2024/jupyterlite-terminal/images/005-1_UxMOxMnDiheATrA044BK5A.mp4" alt="" loading="lazy" data-body-image=""></p> <ul> <li>You can even run <code>lua</code> scripts from the command line:</li> </ul> <p><img src="https://jasongrout.github.io/medium-archive/pelican/posts/2024/jupyterlite-terminal/images/006-1_LbyGHamQs-_pNmk2vmDdfQ.mp4" alt="" loading="lazy" data-body-image=""></p> <ul> <li>To list the available commands press <code>tab</code> in an empty prompt:</li> </ul> <p><img src="https://jasongrout.github.io/medium-archive/pelican/posts/2024/jupyterlite-terminal/images/007-1__qX0_9_LgO1r9Is5Oj7u5Q.webp" alt="List of supported commands" loading="lazy" data-body-image=""></p> <h2 id="how-does-it-work">How does it work?</h2> <p>In JupyterLab the Terminal connects to a real shell such as <code>bash</code> running on the server. In JupyterLite the Terminal runs entirely within the browser with commands that are compiled to WebAssembly and glued together with TypeScript to provide <code>bash</code>-like functionality.</p> <p>The WebAssembly commands are compiled on <a href="https://emscripten-forge.org/">Emscripten-forge</a> and automatically packaged up when you build a JupyterLite deployment using the Terminal.</p> <p>You can see which Emscripten-forge packages are included in your Terminal using the <code>cockle-config</code> command:</p> <p><img src="https://jasongrout.github.io/medium-archive/pelican/posts/2024/jupyterlite-terminal/images/008-1_5xqYgXmsS6dJsonJCBU23g.webp" alt="" loading="lazy" data-body-image=""></p> <h2 id="what-is-the-status-of-the-project">What is the status of the project?</h2> <p>The JupyterLite Terminal is still experimental and there are lots of things it doesn’t yet do. But it is under active development and major improvements are planned for the coming months. These will include more commands, improved<code>bash</code>-like shell functionality, and instructions on how to build and use your own WebAssembly commands.</p> <h2 id="resources">Resources</h2> <p><a href="https://jupyterlite-terminal.vercel.app/">JupyterLite deployment</a> to try out the Terminal.</p> <p>Github repositories:</p> <ul> <li><a href="https://github.com/jupyterlite/terminal">terminal</a>: JupyterLite extension for the Terminal.</li> <li><a href="https://github.com/jupyterlite/cockle">cockle</a>: underlying <code>bash</code>-like shell functionality.</li> <li><a href="https://github.com/emscripten-forge/recipes">recipes</a>: Emscripten-forge recipes for WebAssembly commands.</li> </ul> <h2 id="acknowledgements">Acknowledgements</h2> <p>This work was performed by <strong>Ian Thomas</strong>, <strong>Jeremy Tuloup</strong> and <strong>Thorsten Beier</strong> at <a href="https://quantstack.net/">QuantStack</a>. Thanks to <a href="https://x.com/TechAtBloomberg">Bloomberg</a> for funding this work and for their ongoing support for JupyterLite in general.</p> <h2 id="about-the-author">About the author</h2> <p><strong>Ian Thomas</strong> is a Scientific Software Developer at <a href="https://quantstack.net/">QuantStack</a>, is a core maintainer of the Open Source projects <a href="https://github.com/matplotlib/matplotlib">Matplotlib</a>, <a href="https://github.com/bokeh/bokeh">Bokeh</a> and <a href="https://github.com/contourpy/contourpy">ContourPy</a>, and has an interest in many parts of the Jupyter ecosystem.</p>