srcbook

srcbook

TypeScript notebook for rapid prototyping

Stars: 2077

Visit
 screenshot

Srcbook is an open-source interactive programming environment for TypeScript that allows users to create, run, and share reproducible programs and ideas. It features AI capabilities for exploring and iterating on ideas, supports exporting to valid markdown format, and enables diagraming with mermaid for rich annotations. Users can locally execute programs through a web interface, powered by Node.js under the Apache2 license.

README:

Srcbook banner

npm version Apache 2.0 license

Examples · Discord · Youtube

Features

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

FAQ

See FAQ.

Getting Started

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

Requirements

  • Node 18+, we recommend using nvm to manage local node versions
  • corepack to manage package manager versions

Installing

We recommend using npx to always run the latest version from npm

# Using npm
npx srcbook@latest start

# Using your pm equivalent
pnpm dlx srcbook@latest start

You can instead use a global install with <pkg manager> i -g srcbook and then directly call srcbook with srcbook start

Current 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

Uninstalling

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

rm -rf ~/.srcbook

# if you configured a global install
npm uninstall -g srcbook

if you used another pm you will need to use it's specific uninstall command

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.

Contributing

For development instructions, see CONTRIBUTING.md.

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for srcbook

Similar Open Source Tools

For similar tasks

For similar jobs