typerion-cli

This is only a client, not the main Typerion package. The main Typerion package can be accessed here: https://www.npmjs.com/package/typerion

About The Project

This is an interactive TypeScript notebook that can be used to develop, prototype, and share software. Typerion is entirely open-source, with a focus on low-barrier-to-use and ease-of-sharing results with other developers.

The Typerion notebook:

• Has a rich code editor with syntax highlighting.
• Supports dynamically importing modules that are loaded from https://unpkg.com/.
• Allows passing context forward between code cells.
• Provides saving and loading behavior so that results can be persisted and shared.

Getting Started

Quick Start

A local instance of Typerion can be started with npx:

npx typerion-cli

Pre-Requisites

Install pnpm

• https://pnpm.io/installation

Install and Run

1. Clone the repo

   git clone https://github.com/Vilos92/typerion.git

2. Navigate to the typerion-cli package.

   cd packages/typerion-cli

3. Install packages

   pnpm install

4. Run in development mode

   pnpm dev

After the last command, the Typerion app can be accessed at http://localhost:3000/

Usage

The Notebook header contains controls to:

• Create cells above and below the current cell.
• Run all cells in the Notebook.
• Save the current Notebook state to a file.
• Load the Notebook state from a file.

Some keyboard shortcuts include:

• CMD + Enter
  • Run the currently focused cell.
• Shift + Enter
  • Run the currently focused cell, and then move to the next cell.
  • If the last cell is currently selected, a new cell is created.
• CMD + Up / Down
  • Move focus up and down the cells in the Notebook.

Contributing

Contributions are greatly appreciated. This project is intended to be fully open-source, and the support and feedback from other developers are fully welcome.

Contact

Gregory Linscheid - Website - [email protected]

Project Link: https://github.com/Vilos92/typerion

Acknowledgments

• Byron Barmby - Design contributions for the logo.

License

Distributed under the Apache 2.0 License. See LICENSE for more information.