Skip to content
ARAL Standard

Quick Start

Get up and running with ARAL in minutes. Create your first agent manifest and validate it with our simple tools.

Installation

Section titled “Installation”

Set up the ARAL toolkit in your preferred language:

TypeScript/Node.js (18+)

Terminal window
npm install @aral-standard/sdk @aral-standard/validator

Python (3.10+)

Terminal window
pip install aral-standard

Verify installation:

Terminal window
# TypeScript
npx @aral-standard/validator --version


# Python
python -c "import aral; print(aral.__version__)"

Create Your First Agent

Section titled “Create Your First Agent”

Create a file called my-agent.json:

{
  "aral": {
    "version": "1.0",
    "profile": "ARAL-CORE",
    "conformance": "strict"
  },
  "agent": {
    "id": "my-first-agent",
    "name": "My First ARAL Agent",
    "version": "0.1.0",
    "description": "A simple ARAL-compliant agent"
  },
  "layers": {
    "runtime": {
      "platform": "node",
      "version": "18.0.0",
      "resources": {
        "memory": "512Mi",
        "cpu": "500m"
      }
    },
    "memory": {
      "persistence": "ephemeral",
      "max_context_tokens": 4096
    },
    "capabilities": {
      "actions": [
        {
          "id": "greet",
          "name": "Greet User",
          "description": "Says hello to a user",
          "parameters": {
            "name": {
              "type": "string",
              "required": true
            }
          }
        }
      ]
    },
    "reasoning": {
      "engine": "llm",
      "model": "gpt-4",
      "temperature": 0.7
    },
    "persona": {
      "role": "assistant",
      "traits": ["helpful", "friendly", "concise"],
      "constraints": ["No harmful content", "Respect privacy"]
    }
  }
}

Validate Your Agent

Section titled “Validate Your Agent”

Run the validator:

Terminal window
npx @aral-standard/validator my-agent.json

If valid, you’ll see:

✓ ARAL version: 1.0
✓ Profile: ARAL-CORE (L1-L5)
✓ Schema validation passed
✓ Conformance: STRICT


Agent is ARAL-CORE compliant! 🎉

What’s Next?

Section titled “What’s Next?”

FAQ

Section titled “FAQ”

What profiles should I use?

Start with ARAL-CORE for standalone agents. Upgrade to ARAL-ORCH for multi-agent coordination or ARAL-INTEROP for cross-system integration.

Do I need a specific language?

No. ARAL works with TypeScript, Python, Go, or any language with the standard SDK.

Is ARAL free?

Yes, ARAL is open source under the MIT license.

What if validation fails?

The validator provides detailed error messages. Check the Troubleshooting Guide for help.