Srcbook

TypeScript & JavaScript notebooks.

Features

Create, run, and share reproducible programs and ideas
Export to valid markdown format (.src.md)
AI features for exploring and iterating on ideas
Local execution with a web interface
Powered by Node.js
Open-source under the Apache2 license

Getting Started

Srcbook runs locally on your machine as a CLI application with a web interface.

Requirements

Node.js v20+
We recommend using nvm to manage local node versions

Installing

You can install the srcbook application from npm:

npm install -g srcbook

Running

srcbook start

You can also run it directly using npx:

# Using npx
npx srcbook start

# Using pnpm
pnpm dlx srcbook start

Here is the current list of commands:

$ srcbook -h
Usage: srcbook [options] [command]

Srcbook is a interactive programming environment for TypeScript

Options:
  -V, --version                 output the version number
  -h, --help                    display help for command

Commands:
  start [options]               Start the Srcbook server
  import [options] <specifier>  Import a Srcbook
  help [command]                display help for command

Updating

You can update srcbook using npm:

npm update -g srcbook

Uninstalling

You can remove srcbook by first removing the package, and then cleaning it's local directory on disk:

npm uninstall -g srcbook
rm -rf ~/.srcbook

Analytics and tracking

In order to improve Srcbook, we collect some behavioral analytics. We don't collect any Personal Identifiable Information (PII), our goals are simply to improve the application. The code is open source so you don't have to trust us, you can verify! You can find more information in our privacy policy.

If you want to disable tracking, you can run Srcbook with SRCBOOK_DISABLE_ANALYTICS=true set in the environment.

Development

For development instructions, see CONTRIBUTING.md.

LuisFX/srcbook