aluma.io

The Aluma Developer Hub

Welcome to the Aluma developer hub. You'll find comprehensive guides and documentation to help you start working with Aluma as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Installing the CLI

The Aluma CLI can be used on Windows, Linux and macOS. Installation is simple:

Install on Windows (x64)

The CLI is a single executable file called aluma that can be installed anywhere you prefer. Here we'll download it and add it to your PATH, so you can use it from the command line whichever directory you're in.

  1. Download Aluma CLI for Windows.

  2. Check that installation was successful. Open a command prompt, go to the directory you downloaded to, and enter the following command:

aluma

You should see the CLI's main help message.

👍

Adding the CLI to the PATH

If you want the binary to be available from any directory, create a new directory (e.g C:\aluma or %APPDATA%\local\aluma) and add this directory to the PATH.

Install on Linux (x64)

The CLI is a single executable file called aluma that can be installed anywhere you prefer.

  1. Download Aluma CLI for Linux.

  2. Make the binary executable

chmod +x aluma
  1. (Optional) Move the binary into your PATH, e.g.
sudo mv ./aluma /usr/local/bin/aluma
  1. Check that installation was successful. Open a command prompt and enter the following command:
aluma

You should see the CLI's main help message.

Install on macOS (x64)

The CLI is a single executable file called aluma that can be installed anywhere you prefer.

  1. Download Aluma CLI for macOS.

  2. Make the aluma binary executable

chmod +x aluma
  1. (Optional) Move the binary into your PATH, e.g.
sudo mv ./aluma /usr/local/bin/aluma
  1. Check that installation was successful. Open a command prompt and enter the following command:
aluma

You should see the CLI's main help message.

Updated about a month ago


What's Next

Logging in

Installing the CLI


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.