workshopsoft/ludic
2
0
Fork 0
Code Issues Pull requests Projects Releases 26 Packages Wiki Activity Actions

feat(cli): install in one command, and call the CLI ludic

Browse source 
Getting started meant cloning the repository, bootstrapping a compiler and
learning a task runner called `x`. That is a contributor's workflow handed to
everyone who wants to try the language.

Installing is now one command:

    curl -fsSL https://workshopsoft.pages.workshopsoft.io/ludic/install.sh | sh

install.sh puts a complete toolchain — compiler, CLI, engine runtime, bundled
ludic.* packages, formatter, language server — in ~/.ludic and adds it to PATH.
Prebuilt artifacts are checksum-verified; where a platform has none, or the
release predates this layout, it bootstraps from the compiler's own IR seed with
clang. The docs site publishes the script beside the pages that quote it, so the
page and the script can never come from different releases.

`x` becomes `ludic`, and the surface splits by audience. A user of the language
sees `new`, `run`, `build`, `test`, `add`, `fmt`, `lsp`, `doctor`, `upgrade`;
`ludic new` scaffolds a project that builds and plays as it stands. Everything
the toolchain repo needs moved under `ludic dev` — build, test, reseed,
bootstrap-cfree, docs-gen, release — unchanged apart from the namespace. Those
tasks read arguments one position further along, so dispatch_dev sets a shift
and commands use arg_n()/arg_total() rather than each knowing its own depth.

Release artifacts become complete install roots (bin/ beside runtime/, packages/
and VERSION) rather than bare binaries, which is what the installer unpacks.
`ludic dev test` asserts the whole shape: it stages an install, puts it on PATH
with no LUDIC_HOME, and runs new -> build -> test through it.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Orkun ÇAKILKAYA 2026-09-05 22:01:52 +03:00
parent 005cc39394
commit aca263642d
54 changed files with 1802 additions and 670 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.forgejo/issue_template/bug.md
View file

@ -24,7 +24,7 @@ labels:
## Environment
- Command used (e.g. `bin/x app foo.ludic --headless`):
- Command used (e.g. `bin/ludic build foo.ludic --headless`):
- Target (native macOS / headless / web-wasm):
- Commit (`git rev-parse --short HEAD`):
- OS / arch:

6
.forgejo/pull_request_template.md
View file

@ -8,13 +8,13 @@ Closes #
## Checklist
- [ ] `bin/x test` passes.
- [ ] For compiler/runtime changes: `bin/x reseed && bin/x bootstrap-cfree`
- [ ] `bin/ludic dev test` passes.
- [ ] For compiler/runtime changes: `bin/ludic dev reseed && bin/ludic dev bootstrap-cfree`
still reaches the self-hosting fixpoint with no C compiler in the loop.
- [ ] `ludic-fmt` leaves the touched files unchanged (2-space, LF, UTF-8).
- [ ] New/changed stdlib symbols are documented under `docs/language/**` and
registered in `tools/docgen/inventory.json`
(`bin/x docs-gen && bin/x docs-check build/pages` passes).
(`bin/ludic dev docs-gen && bin/ludic dev docs-check build/pages` passes).
- [ ] Commits follow [Conventional Commits](https://www.conventionalcommits.org).
- [ ] No new C / Python / JS in tooling (Ludic only), and no generated
artifacts committed outside `build/` / `bin/`.

6
.forgejo/workflows/bootstrap.yml
View file

@ -43,11 +43,11 @@ jobs:
set -eu
mkdir -p bin
clang-16 tools/ci/linux_stdio_shim.ll selfhost/ludicc.seed.ll -o bin/ludicc
bin/ludicc tools/x/main.ludic -o bin/x
bin/ludicc tools/ludic-cli/main.ludic -o bin/ludic
- name: Rebuild the compiler from the seed and assert byte-identity
# `x bootstrap-cfree` assembles the seed with clang, has that seed
# `ludic dev bootstrap-cfree` assembles the seed with clang, has that seed
# compiler recompile selfhost.ludic to out.ll, and `cmp`s out.ll against
# the checked-in seed. It returns non-zero if they differ — i.e. if the
# seed is stale relative to the compiler source.
run: bin/x bootstrap-cfree
run: bin/ludic dev bootstrap-cfree

28
.forgejo/workflows/ci.yml
View file

@ -2,7 +2,7 @@ name: ci
# Build the language toolchain from its IR seed and run the regression suites on
# every push to main and every pull request. Until this landed the only workflow
# was docs.yml, so nothing gated a change on `x test` / `x test-tools` or on the
# was docs.yml, so nothing gated a change on `ludic dev test` / `ludic dev test-tools` or on the
# compiler even building from the seed. See also bootstrap.yml, which proves the
# C-free self-rebuild reproduces the seed byte-for-byte.
on:
@ -45,7 +45,7 @@ jobs:
# The toolchain is macOS-first; on this Linux runner it links against a
# tiny C-free IR shim that supplies the Darwin standard-stream globals
# (__stdoutp/__stderrp) over glibc's stdout/stderr. Injected through
# LUDIC_CC so every clang invocation — the seed bootstrap, `x build`,
# LUDIC_CC so every clang invocation — the seed bootstrap, `ludic dev build`,
# and each compiled test program — picks it up. Absolute path so it
# still resolves if a step changes directory.
echo "LUDIC_CC=clang-16 $(pwd)/tools/ci/linux_stdio_shim.ll" >> "$GITHUB_ENV"
@ -60,20 +60,20 @@ jobs:
# pre-built binaries: the language builds itself from source + seed.
mkdir -p bin
clang-16 tools/ci/linux_stdio_shim.ll selfhost/ludicc.seed.ll -o bin/ludicc
bin/ludicc tools/x/main.ludic -o bin/x
bin/x build
bin/ludicc tools/ludic-cli/main.ludic -o bin/ludic
bin/ludic dev build
- name: Regression suite (x test)
run: bin/x test
- name: Regression suite (ludic dev test)
run: bin/ludic dev test
- name: Editor-toolchain suite (x test-tools)
- name: Editor-toolchain suite (ludic dev test-tools)
# Grammar/lexer/vocabulary sync, ludic-fmt idempotence (the project's
# formatting contract — hand alignment is deliberately preserved, so the
# gate is fmt(fmt(x)) == fmt(x), not fmt(x) == x), and the JSON/XML editor
# assets. Cross-file LSP behaviour and the golden renders are macOS-ABI
# bound and skip here — visibly — until the runtime's directory walk and
# windowing are portable.
run: bin/x test-tools
run: bin/ludic dev test-tools
- name: Docs cover the implementation
run: |
@ -81,9 +81,9 @@ jobs:
# The whole docs toolchain is written in Ludic and runs through x —
# no Python anywhere. check-impl / check-vocabulary / check-docs guard
# the sources; docs-gen builds the site and docs-check is its coverage
# + integrity guard. (check-vocabulary also runs in `x test-tools`.)
bin/x check-impl
bin/x check-vocabulary
bin/x check-docs
bin/x docs-gen --out build/pages
bin/x docs-check build/pages
# + integrity guard. (check-vocabulary also runs in `ludic dev test-tools`.)
bin/ludic dev check-impl
bin/ludic dev check-vocabulary
bin/ludic dev check-docs
bin/ludic dev docs-gen --out build/pages
bin/ludic dev docs-check build/pages

12
.forgejo/workflows/docs.yml
View file

@ -10,7 +10,7 @@ on:
paths:
- 'docs/**'
- 'tools/docgen/**'
- 'tools/x/**'
- 'tools/ludic-cli/**'
- '.forgejo/workflows/docs.yml'
workflow_dispatch: {}
@ -33,8 +33,8 @@ jobs:
# "Waiting" forever with "no online runner found matching this label".
runs-on: docker
# The generator is now Ludic, so this builds the toolchain from its IR seed
# (clang assembles the seed into bin/ludicc, which compiles bin/x) exactly
# like the ci workflow, then runs `x docs-gen`. node:20-bookworm carries git
# (clang assembles the seed into bin/ludicc, which compiles bin/ludic) exactly
# like the ci workflow, then runs `ludic dev docs-gen`. node:20-bookworm carries git
# for the clone + publish; clang-16 is the only extra the bootstrap needs.
container: node:20-bookworm
steps:
@ -63,9 +63,9 @@ jobs:
export LUDIC_HOME="$(pwd)"
mkdir -p bin
clang-16 tools/ci/linux_stdio_shim.ll selfhost/ludicc.seed.ll -o bin/ludicc
bin/ludicc tools/x/main.ludic -o bin/x
bin/x docs-gen --out ../public
bin/x docs-check ../public
bin/ludicc tools/ludic-cli/main.ludic -o bin/ludic
bin/ludic dev docs-gen --out ../public
bin/ludic dev docs-check ../public
cd ..
echo "--- generated files ---"
ls -la public

16
.forgejo/workflows/release.yml
View file

@ -1,6 +1,6 @@
name: release
# Cutting a release is `x release` + `git push --tags`; everything after that
# Cutting a release is `ludic dev release` + `git push --tags`; everything after that
# happens here. Before this workflow existed the artifacts were built on whatever
# machine the maintainer happened to be sitting at, from whatever was in bin/ at
# the time, with no checksums and nothing proving the tagged tree even passed its
@ -71,15 +71,15 @@ jobs:
set -eu
mkdir -p bin
clang-16 tools/ci/linux_stdio_shim.ll selfhost/ludicc.seed.ll -o bin/ludicc
bin/ludicc tools/x/main.ludic -o bin/x
bin/x build
bin/ludicc tools/ludic-cli/main.ludic -o bin/ludic
bin/ludic dev build
- name: The tagged tree must pass its own suites
run: |
set -eu
bin/x test
bin/x test-tools
bin/x bootstrap-cfree
bin/ludic dev test
bin/ludic dev test-tools
bin/ludic dev bootstrap-cfree
- name: Publish the release
env:
@ -91,9 +91,9 @@ jobs:
echo "::error::No FORGEJO_TOKEN secret; cannot create the release."
exit 1
fi
# x publish builds dist/ (source tarball from the tag, this host's
# ludic dev publish builds dist/ (source tarball from the tag, this host's
# toolchain, SHA256SUMS), takes the notes from the CHANGELOG section,
# and creates the release. Re-running it only adds missing assets, so
# a maintainer can afterwards attach the macOS toolchain from a Mac
# with the same command.
bin/x publish "$TAG"
bin/ludic dev publish "$TAG"