Get started
HollowScript v0.1.1 is a public preview. Its command line, embedding API and bytecode format may change before 1.0. It implements specification 1.1.1.
Supported platforms
Section titled “Supported platforms”Signed downloads are available for macOS on Apple Silicon, Linux on x86_64 (a static build that runs on glibc and musl distributions) and Windows on x86_64.
Install
Section titled “Install”On macOS or Linux, run this in a terminal:
curl -fsSL https://get.hollowscript.org/install.sh | sh -s -- --version v0.1.1This downloads the command line tool and language server into ~/.hollowscript/bin.
On Windows, run this in PowerShell (Windows PowerShell 5.1 or PowerShell 7):
$env:HOLLOWSCRIPT_VERSION = 'v0.1.1'; irm https://get.hollowscript.org/install.ps1 | iexThis installs into %LOCALAPPDATA%\hollowscript\bin and adds it to your user PATH; open a new terminal afterwards.
The installers verify the release signature with minisign or OpenSSH and check the SHA-256 checksum before installing anything. Downloads are signed by the HollowScript project rather than through Apple notarisation or Windows Authenticode, so if Windows Smart App Control is turned on it may block them.
Restart your shell, then check the version:
hollowscript versionTo avoid changing your shell profile, add --no-modify-path to the installer options (-NoModifyPath on Windows) and run the installed hollowscript directly. Set HOLLOWSCRIPT_HOME (on Windows, HOLLOWSCRIPT_INSTALL_DIR) for the installing shell to choose another installation directory.
Run a program
Section titled “Run a program”Save this as hello.hws:
uses print
effect print("Hello, HollowScript")Then run:
hollowscript check hello.hwshollowscript run hello.hwsThe program prints Hello, HollowScript. Continue with the tour or read the specification.
Verify the release
Section titled “Verify the release”The public release provides the source, checksums, both signature formats and verification instructions. The release includes a software bill of materials, third-party licences and build records, all covered by the signed checksums. Every product is built twice, from separate checkouts, and must match byte for byte before it is released.
We recommend pinning a version with --version, as shown above. Without it, the installer follows the latest-release pointer, which is not yet signed; signed release pointers are planned before 1.0.
Uninstall
Section titled “Uninstall”curl -fsSL https://get.hollowscript.org/install.sh | sh -s -- --uninstallOn Windows:
& ([scriptblock]::Create((irm https://get.hollowscript.org/install.ps1))) -UninstallThis removes the installed tools and the PATH entry the installer added.
Source and editor support
Section titled “Source and editor support”The source is available under Apache-2.0 or MIT in the release mirror. Documentation is CC BY 4.0, with separate trademark terms for the branding. Each release is published there as a single snapshot, and issue reports are welcome.
The language server ships with the command line tool, so any editor that supports the Language Server Protocol can use it. The source also includes a VS Code extension.
Use the support page for help, and the repository’s private vulnerability reporting for security issues.
HollowScript™ is a trademark of Soulstack. See the trademark policy.