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.
Download and install
Section titled “Download and install”curl -Lo vertex https://github.com/vertex-run/vertex/releases/latest/download/vertex-macos-arm64chmod +x vertexsudo mv vertex /usr/local/bin/curl -Lo vertex https://github.com/vertex-run/vertex/releases/latest/download/vertex-macos-x86_64chmod +x vertexsudo mv vertex /usr/local/bin/curl -Lo vertex https://github.com/vertex-run/vertex/releases/latest/download/vertex-linux-x86_64chmod +x vertexsudo mv vertex /usr/local/bin/Download vertex-windows-x86_64.exe from the
releases page,
rename it to vertex.exe, and place it in a folder on your PATH.
Verify
Section titled “Verify”vertex --versionYou should see a version string. If you see command not found, the
binary is not on your PATH; double-check the install location.
What you get
Section titled “What you get”The vertex binary is everything you need to:
- Run
.vtxfiles 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.
Optional: Salesforce tooling
Section titled “Optional: Salesforce tooling”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.