Your first project

This assumes sphp is installed.

Create it

mkdir hello && cd hello
sphp init --yes

sphp init asks for a name, the source and output directories, and whether to allow plain .php files; --yes takes the defaults. It writes:

• sphp.toml, the project configuration (see Configuration)
• src/main.sphp, a first program
• a .gitignore entry for the output directory

Check it

sphp check

sphp check type-checks every file under src/. Errors are shown with their location and a stable code you can look up in Diagnostics:

error[SPHP0005]: type mismatch in declaration: "ten" is not assignable to Int
   ╭─[ src/main.sphp:3:14 ]
   │
 3 │ val n: Int = "ten"
   │              ──┬──
   │                ╰──── type mismatch in declaration: "ten" is not assignable to Int
───╯

Build it

sphp build
php build/main.php

sphp build checks the project, then writes one .php file (and a .php.map source map) per source file to build/. Code that uses the standard library also gets build/stir-runtime.php, which the generated files require.

While you work, keep it rebuilding:

sphp build --watch

Use it from PHP

The output is plain PHP: load it with Composer like any other code.

{
    "autoload": { "classmap": ["build/"] }
}

From here, the Language section walks through StirPHP itself.