Prerequisites

Before you start with Daana CLI, make sure you have the following prerequisites installed and configured.

System Requirements

Minimum Requirements

Operating System: macOS, Linux, or Windows 10/11
RAM: 2GB free memory
Disk Space: 2GB free space
Docker Desktop: Required for running databases

Supported Platforms

Daana CLI provides pre-built binaries for:

macOS (Intel and Apple Silicon)
Linux (AMD64 and ARM64)
Windows (AMD64 and ARM64)

Required Software

Docker Desktop

Docker is required to run the PostgreSQL databases that Daana CLI uses.

Installation:

macOS: Download from docker.com/products/docker-desktop (opens in a new tab)
Windows: Download from docker.com/products/docker-desktop (opens in a new tab)
Linux: Follow instructions at docs.docker.com/engine/install (opens in a new tab)

Verify Docker is running:

docker --version
# Should show: Docker version 20.x.x or higher
 
docker ps
# Should show container list (may be empty)

If you see "Cannot connect to the Docker daemon", make sure Docker Desktop is running.

Three Paths to Get Started

Choose your path based on how you want to use Daana CLI:

🎯 Path 1: Beta Tester (Recommended - Pre-built Binary)

You should use this path if:

You want to learn and use Daana CLI
You received a beta tester invitation
You prefer pre-built binaries

What you need:

✅ Access to the daana-cli binary (provided by Daana team)
✅ Docker Desktop installed

What you get:

Pre-built binary (no compilation needed)
Full tutorial via daana-cli init --example olist
Complete Olist dataset included

Note: As a beta tester, you'll receive the daana-cli binary directly. Then run init --example olist to get the complete tutorial project with data.

🚀 Path 2: Self-Service Evaluation (Build from Source)

You should use this path if:

You want to try Daana CLI immediately
You don't have beta access yet
You're comfortable building from source

What you need:

✅ Git and Go 1.23+ installed
✅ Task automation tool
✅ Docker Desktop installed

Quick start:

# Clone and build
git clone --recurse-submodules https://github.com/daana-code/daana-cli.git
cd daana-cli
task setup
task build
 
# Get complete tutorial with data
./daana-cli init --example olist
cd olist-quickstart
# Follow README.md for tutorial

What you get:

Same experience as beta testers
Complete Olist tutorial with real data
All features available

This path works right now! No need to wait for beta access. The init --example olist command includes everything you need (24MB dataset, models, configs).

🛠️ Path 3: Contributor (For code contributors)

You should use this path if:

You want to contribute code to Daana CLI
You want to build from source
You need to modify the tool itself

What you need:

✅ GitHub repository access (request from Daana team)
✅ Go 1.23 or higher
✅ Task automation tool
✅ Git

Repository Access:

# Clone the repository (requires GitHub access)
git clone --recurse-submodules https://github.com/daana-code/daana-cli.git

Note: If you're just learning Daana CLI, use Path 1 instead!

Beta Tester Checklist

If you're following Path 1 (Beta Tester), verify you have:

Access to daana-cli binary (provided by Daana team)
Access to olist-quickstart package (provided by Daana team)
Docker Desktop installed and running
2GB free disk space
30 minutes for the complete tutorial

Don't have beta access yet? Contact the Daana team for an invitation.

Note: The Daana team will provide you with direct links to download the binary and quickstart package. These are not yet available on public release pages as the repository is private during beta.

Contributor Checklist

If you're following Path 2 (Contributor), verify you have:

Next Steps

Once you've verified all prerequisites, continue to Setup → to configure your environment.

Troubleshooting

Docker Won't Start

macOS/Windows: Make sure you've granted Docker Desktop the necessary permissions in System Preferences/Settings.

Linux: Ensure your user is in the docker group:

sudo usermod -aG docker $USER
# Log out and back in for changes to take effect

Insufficient Disk Space

The complete setup (Docker images + databases + data) uses approximately 1.5-2GB of disk space. You can check available space:

# macOS/Linux
df -h
 
# Windows (PowerShell)
Get-PSDrive

Repository Access Issues

If you can't access the repository, verify:

You're logged into GitHub
Your GitHub account has been granted access
You're using the correct repository URL

Contact your Daana representative if access issues persist.

Introduction Setup