Docs: TypeScript-to-Native Compiler hero, npm install quickstart

- Quickstart installs from npm; from-source moves to a pointer at the repo
- Node floor matches the package engines field
This commit is contained in:
Chris Tate
2026-07-22 18:45:02 -05:00
parent 60a135f505
commit bcc094862b
2 changed files with 7 additions and 12 deletions
+2 -2
View File
@@ -82,8 +82,8 @@ export default function Home() {
macOS · Linux · Windows
</p>
<h1 className="mx-auto mt-4 max-w-5xl heading-40 text-gray-1000 sm:heading-64 lg:heading-72">
The native compiler <br className="hidden sm:block" />
for TypeScript
TypeScript-to-Native <br className="hidden sm:block" />
Compiler
</h1>
<p className="mx-auto mt-4 max-w-2xl copy-16 text-gray-900 sm:copy-18">
Ordinary TypeScript becomes a small, fast native binary — no Node, no V8, no
+5 -10
View File
@@ -1,25 +1,20 @@
# Quickstart
scriptc is installed from source today; an npm package (`npm install -g scriptc`) is coming. Building from a clone takes a couple of minutes.
Install the CLI from npm and compile your first binary in a couple of minutes.
## Prerequisites
- **macOS arm64** is the primary platform ([Linux and Windows](/platforms) are cross-compilation targets).
- **clang** — preinstalled with the Xcode Command Line Tools.
- **Node ≥ 24** and **pnpm** — for the compiler itself. The binaries it produces need neither.
- **Node ≥ 20** — to run the compiler. The binaries it produces need no Node at all.
## Install from source
## Install
```console
$ git clone https://github.com/vercel-labs/scriptc && cd scriptc
$ pnpm install && pnpm build
$ npm install -g scriptc
```
The repo exposes the CLI as a package script, so `pnpm scriptc` works from the repo directory. For a shell-wide command, alias it:
```console
$ alias scriptc="pnpm --dir $PWD scriptc"
```
To work from a clone instead (`pnpm install && pnpm build` in the repo, then `pnpm scriptc` from the repo directory), see the [repository](https://github.com/vercel-labs/scriptc).
## Your first binary