Installation#

Getting Adama running is mostly "install Java, download a JAR, create an account." Nothing exotic. Let's get through it.

Prerequisites#

Adama runs on Java 17 or later. Most operating systems can install Java through their package manager.

Verify Java Installation#

Open a terminal and run:

java -version

You should see something like:

openjdk version "17.0.7" 2023-04-18
OpenJDK Runtime Environment (build 17.0.7+7-Ubuntu-0ubuntu122.04.2)
OpenJDK 64-Bit Server VM (build 17.0.7+7-Ubuntu-0ubuntu122.04.2, mixed mode, sharing)

Note: The exact version numbers don't matter. Any Java 17+ works.

Installing Java#

If Java isn't installed or you're stuck on an older version:

macOS (using Homebrew):

brew install openjdk@17

Ubuntu/Debian:

sudo apt update
sudo apt install openjdk-17-jdk

Windows: Download from Oracle's website or use Chocolatey:

choco install openjdk17

Installing the CLI#

The Adama CLI is a single JAR file. One download, no installer, no dependency tree from hell.

Using wget:

wget https://aws-us-east-2.adama-platform.com/adama.jar

Using curl:

curl -fSLO https://aws-us-east-2.adama-platform.com/adama.jar

Direct download: You can also download directly from GitHub releases .

Verify the Installation#

Run the CLI to make sure it's alive:

java -jar adama.jar

You should see a help message listing commands like init, space, kickstart, and others.

Tip: Consider creating an alias in your shell configuration:

alias adama="java -jar /path/to/adama.jar"

This lets you run adama instead of java -jar adama.jar. Your fingers will thank you.

Creating a Developer Account#

You need an account to create spaces and deploy documents. Initialize with:

java -jar adama.jar init

This walks you through account setup:

1. Accept Terms: You'll see a notice about Adama's terms, conditions, and privacy policy. Providing your email implies acceptance.

2. Enter Email: Type your email address and press Enter.

3. Verify: Check your email for a verification code. Copy and paste it into the terminal.

4. Revoke Previous Sessions (optional): If you've used Adama on other machines, you can revoke those sessions for security.

Security Note: The init command creates a configuration file at ~/.adama containing your credentials. Keep this file secure. If you work on shared machines, use the revocation feature when asked.

Configuration File#

After initialization, your credentials live in ~/.adama. You can override this location with the --config parameter:

java -jar adama.jar --config /path/to/config space list

Verifying Everything Works#

Test your setup by listing your spaces:

java -jar adama.jar space list

If you just created your account, this returns an empty list. That's expected — you haven't created anything yet.

You can also poke around with:

java -jar adama.jar space help

This shows all space-related operations: create, list, deploy, and more.

Troubleshooting#

"java: command not found"#

Java isn't installed or isn't in your PATH. Install Java 17+ and make sure it's accessible from your terminal.

Connection Timeout#

The JAR download needs a stable internet connection. If wget or curl times out:

• Try again with a better connection
• Download manually from GitHub releases
• Check if a firewall is blocking things

Permission Denied#

On Unix systems, make sure you have write permission in the directory where you're downloading the JAR.

Verification Email Not Received#

• Check your spam folder
• Make sure you typed the email correctly
• Wait a few minutes and try again
• Contact support if it keeps happening

Now let's actually see what Adama can do. Continue to Five-Minute Tour.