Architect

Getting Started with AIVory Architect

Get up and running with AIVory Architect in minutes. This guide walks you through installing the plugin and designing your first infrastructure.

Visual infrastructure design with drag-and-drop canvas
Multi-format code generation for Terraform, Docker, and Kubernetes
Direct deployment from your IDE with real-time monitoring
Secure credential storage with encrypted vault

What You Can Do

AIVory Architect brings infrastructure-as-code to life:

Design Visually

Drag and drop cloud resources onto a canvas and connect them

Generate Code

Automatically create Terraform, Docker Compose, and Kubernetes files

Deploy Directly

Run terraform apply or kubectl apply without leaving your IDE

Manage Credentials

Store cloud provider API keys securely in an encrypted vault

Monitor Resources

View your deployed infrastructure across all cloud providers

Step 1: Install AIVory Architect

Choose your IDE:

JetBrains

IntelliJ, WebStorm, PyCharm

Command Line Installation

# VS Code
code --install-extension AIVory.aivory-architect

# Cursor / Antigravity (from VSIX)
cursor --install-extension aivory-architect.vsix

Step 2: Open the Designer

JetBrains IDEs

Click AIVory Architect tab in right sidebar, or View → Tool Windows → AIVory Architect

VS Code / Cursor

Click AIVory Architect icon in Activity Bar, then click Open Designer

Note AIVory Architect works with existing Terraform configurations. When you open a project with .tf files, the designer automatically visualizes your infrastructure. This works in both free and premium tiers.

Step 3: Choose Your Path

Setup Wizard Recommended

Guided 8-step process for new projects. Perfect when starting from scratch.

Visual Designer

Freeform drag-and-drop canvas. Best for custom architectures.

Setup Wizard Steps

Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
Run Architect: Open Setup Wizard
Follow the 8-step wizard:
- Project basics (name, type, scale)
- Compliance requirements
- Cloud provider selection
- Infrastructure configuration
- Advanced options
- Container strategy
- Review and cost estimate
- Generate files

Visual Designer Quick Start

In the Resource Palette, select a cloud provider (e.g., Hetzner, AWS)
Drag a resource (e.g., Server/VM) onto the canvas
Click the resource to open the Properties Panel
Configure the resource (name, size, region, etc.)

Step 4: Connect Resources

Creating connections defines dependencies between resources:

Hover over a resource to see connection points
Drag from one connection point to another
This defines dependencies (e.g., VM depends on Network)

Example: Basic Web Server Setup

Step-by-Step Instructions

Drag a Network onto the canvas
Drag a Server onto the canvas
Connect Network → Server
Drag a Database onto the canvas
Connect Server → Database

Step 5: Generate Code

Click Generate Terraform in the toolbar
Review the generated files:
- main.tf - Resource definitions
- variables.tf - Input variables
- outputs.tf - Output values
- providers.tf - Provider configuration
Files are saved to .aivory/terraform/ in your project

Note Generated code follows Terraform best practices and is fully customizable after generation.

Generated Code Example

# main.tf
resource "hcloud_network" "main" {
  name     = "main-network"
  ip_range = "10.0.0.0/8"
}

resource "hcloud_server" "web" {
  name        = "web-server"
  server_type = "cx21"
  image       = "ubuntu-22.04"

  network {
    network_id = hcloud_network.main.id
  }
}

Step 6: Deploy

Success Direct deployment from the IDE requires a premium subscription.

With a premium subscription:

Click Deploy in the toolbar
AIVory Architect runs terraform init automatically
Review the terraform plan output
Confirm to run terraform apply
Monitor progress in real-time

After deployment, use the Infrastructure tab to:

Monitor Status

View resource health across providers

SSH Access

Connect to servers directly

Stream Logs

Real-time log viewing

Manage Containers

Docker and Kubernetes operations

Step 7: Configure Credentials

For deployment, add your cloud provider credentials.

Credential Vault Recommended

Securely stores API keys with AES-256 encryption

Environment Variables

Traditional .env file approach

Using the Credential Vault

Open the Vault tab in Architect
Click Add Credential
Select provider type (AWS, Azure, Hetzner, etc.)
Enter your credentials
Click Save

Full Credential Vault Guide →

Using Environment Variables

Create a .env file in your project:

HCLOUD_TOKEN=your-hetzner-token
AWS_ACCESS_KEY_ID=your-aws-key
AWS_SECRET_ACCESS_KEY=your-aws-secret

Warning Add .env to your .gitignore file to prevent accidentally committing secrets.

Troubleshooting

Plugin Not Appearing

JetBrains: Restart IDE after installation. Check Settings → Plugins → Installed to verify.
VS Code: Run Developer: Reload Window from Command Palette.

Terraform Generation Fails

Ensure all required resource properties are configured
Check the Problems panel for validation errors
Verify provider credentials if using managed resources

Deployment Issues

Verify credentials in the Vault or .env file
Check cloud provider quota limits
Review the deployment logs in the Output panel

Next Steps

Visual Designer Guide

Master the canvas, palette, and property panels

Setup Wizard

Guided infrastructure configuration

Terraform Generation

Understand code generation and customization

Infrastructure Management

Monitor and operate deployed resources

Kubernetes Management

Deploy and manage K8s workloads

Credential Vault

Secure credential storage

Need Help?

FAQ

Common questions answered

Contact Support

Get personalized help

GitHub Issues

Report bugs and feature requests