OxL Reference

Checking the installation

sh
oxl --version                      # oxl 1.0.0-beta (edition 2027)
oxl help

The first program#

sh
mkdir -p /tmp/oxl-smoke && cd /tmp/oxl-smoke
cat > hello.oxl <<'EOF'
fn main() io { print("Привет, OxL!") }
EOF
oxl run hello.oxl
oxl fmt --check hello.oxl

If oxl run prints linking failed, the system libraries or the linker are missing. If it prints standard library not found, set OXL_STD_DIR to the lib/oxl/std directory of the installation.

A package, tests and a cluster#

sh
oxl new smoke && cd smoke
oxl test                           # 1 passed
oxl dev --nodes 3

In the oxl dev table every node must reach the state up and the VIEW column must show 3/3 (all nodes see each other). Examples from the archive: oxl test /opt/oxl-1.0.0-beta/share/oxl/examples/bank-saga (copy the project to a writable directory: oxl creates oxl.schema.lock and .oxl/ in the project).

Editor and debugger#

  • oxl lsp answers an initialize request: details and a check in LSP clients.
  • oxl dap --help finds lldb-dap; otherwise install lldb-18 or set OXL_LLDB_DAP.
  • oxl doc --std --json | head prints the documentation of the standard library, which shows that std is found.

Troubleshooting#

SymptomCause and fix
oxl: command not foundPATH does not contain <installation>/bin
linking failed: cannot find -luring (or another -l…)the -dev package of the library is missing, see the requirements
linking failed without details, clang++: not foundno clang: install clang-18 and export OXL_LINKER=clang++-18
standard library not found / runtime library not founda moved installation: OXL_STD_DIR, OXL_RUNTIME_LIB
cannot start the cluster member: … no credentialsa cluster program run outside oxl dev: set OXL_CLUSTER_CERT/KEY/CA or use oxl dev
OxL 1.0.0-beta · Documentation version 1.0.0-beta© OxwaldLink · generated from the Standard, the std sources and the guides