Skip to content

Quick Start Guide

Get started with UnaCODE in under 10 minutes.

Prerequisites

  • Basic understanding of AI concepts
  • Command line familiarity
  • A UnaCODE account (sign up at unacode.mrmaidenos.com)

Step 1: Install the CLI

# Install via Homebrew
brew install unacode/tap/unacode

# Or download directly
curl -L https://releases.unacode.com/cli/latest/darwin/unacode -o unacode
chmod +x unacode
sudo mv unacode /usr/local/bin/

# Install via package manager
wget https://releases.unacode.com/cli/latest/linux/unacode
chmod +x unacode
sudo mv unacode /usr/local/bin/

# Download Windows binary
Invoke-WebRequest -Uri "https://releases.unacode.com/cli/latest/windows/unacode.exe" -OutFile "unacode.exe"

# Add to PATH or run from current directory
.\unacode.exe --version

Step 2: Authenticate

# Login to your UnaCODE account
unacode auth login

# Verify authentication
unacode auth status

Step 3: Create Your First Agent

# Create a new agent project
unacode create agent --name "my-first-agent" --template basic

# Navigate to the project
cd my-first-agent

Step 4: Configure the Agent

Edit the agent.yml configuration:

name: my-first-agent
description: A simple greeting agent
version: 1.0.0

# Define the workflow
workflow:
  - name: input
    type: text-input
    config:
      prompt: "What's your name?"

  - name: process
    type: llm-completion
    config:
      model: gpt-4
      prompt: "Create a personalized greeting for: {{input.text}}"

  - name: output
    type: text-output
    config:
      message: "{{process.completion}}"

# Connect the nodes
connections:
  - from: input.text
    to: process.input
  - from: process.completion
    to: output.message

Step 5: Test Your Agent

# Run the agent locally
unacode run

# Test with sample input
unacode test --input "Alice"

Expected output: 

Hello Alice! It's wonderful to meet you. I hope you're having a great day!

Step 6: Deploy to the Cloud

# Deploy to UnaCODE platform
unacode deploy

# Check deployment status
unacode status

Next Steps

🎉 Congratulations! You've created your first UnaCODE agent.

What's Next?

Need Help?