Skip to content

Install Vertex

Vertex ships as a single binary per platform. Grab the one for your machine from the latest release and put it on your PATH.

Terminal window
curl -Lo vertex https://github.com/vertex-run/vertex/releases/latest/download/vertex-macos-arm64
chmod +x vertex
sudo mv vertex /usr/local/bin/
vertex --version

You should see a version string. If you see command not found, the binary is not on your PATH; double-check the install location.

The vertex binary is everything you need to:

  • Run .vtx files locally: vertex run hello.vtx
  • Test your code: vertex test
  • Build Apex classes for deployment: vertex build
  • Serve the language server for your editor: vertex lsp

See The vertex CLI for the full command reference.

To deploy the Apex classes that vertex build emits, you will also want the Salesforce CLI (sf). It is not required for writing or running Vertex locally; only for pushing the generated code to an org.

Run your first program: Your first Vertex program.