https://github.com/srcbookdev/srcbook/blob/main/README.md Skip to content Navigation Menu Toggle navigation Sign in * Product + GitHub Copilot Write better code with AI + Security Find and fix vulnerabilities + Actions Automate any workflow + Codespaces Instant dev environments + Issues Plan and track work + Code Review Manage code changes + Discussions Collaborate outside of code + Code Search Find more, search less Explore + All features + Documentation + GitHub Skills + Blog * Solutions By company size + Enterprises + Small and medium teams + Startups By use case + DevSecOps + DevOps + CI/CD + View all use cases By industry + Healthcare + Financial services + Manufacturing + Government + View all industries View all solutions * Resources Topics + AI + DevOps + Security + Software Development + View all Explore + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Enterprise + Enterprise platform AI-powered developer platform Available add-ons + Advanced Security Enterprise-grade security features + GitHub Copilot Enterprise-grade AI features + Premium Support Enterprise-grade 24/7 support * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up Reseting focus You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} srcbookdev / srcbook Public * Notifications You must be signed in to change notification settings * Fork 59 * Star 2.1k * Code * Issues 14 * Pull requests 8 * Discussions * Actions * Projects 0 * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights Files main Breadcrumbs 1. srcbook / README.md [ ] Blame Blame Latest commit History History 122 lines (84 loc) * 4.61 KB main Breadcrumbs 1. srcbook / README.md Top File metadata and controls * Preview * Code * Blame 122 lines (84 loc) * 4.61 KB Raw Srcbook banner npm version Apache 2.0 license Examples * Discord * Youtube Srcbook Srcbook is a TypeScript-centric app development platform. It allows you to create and iterate on web apps incredibly fast using AI as a pair-programmer. It can create or edit web apps, and also write and execute backend code through an interactive notebook interface. Srcbook is open-source (apache2) and runs locally on your machine. You need to bring your own API key for AI usage (we strongly recommend Anthropic with claude-3-5-sonnet-latest). Features App Builder * AI app builder for TypeScript * Create, edit and run web apps * Use AI to generate the boilerplate, modify the code, and fix things * Edit the app with a hot-reloading web preview Example Srcbook Notebooks * Create, run, and share TypeScript notebooks * 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 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 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] Import a Notebook 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. Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.