Quickstart Guide - Archyl Docs

Get started with Archyl in 5 minutes - create your first architecture diagram

Quickstart Guide

This guide will help you create your first architecture diagram in Archyl in just a few minutes.

Step 1: Create an Account

  1. Go to app.archyl.com
  2. Sign up using your email or connect with GitHub, GitLab, or Bitbucket
  3. Verify your email if you signed up with email

Step 2: Create Your First Project

  1. Click "New Project" on your dashboard
  2. Enter a name for your project (e.g., "My E-commerce Platform")
  3. Optionally add a description and tags
  4. Click "Create Project"

Step 3: Add Your First System

  1. In your new project, you'll start at the System Context level
  2. Click the "+" button or right-click on the canvas
  3. Select "Add System"
  4. Enter a name (e.g., "E-commerce Platform")
  5. Add a description of what the system does

Step 4: Add External Systems

Real systems don't exist in isolation. Add external systems your software interacts with:

  1. Click "+" and select "Add External System"
  2. Add systems like "Payment Gateway", "Email Service", "CDN"
  3. These will appear with a different style to show they're external

Step 5: Create Relationships

Show how systems communicate:

  1. Click on the source system
  2. Drag from the connection point to the target system
  3. Add a label describing the relationship (e.g., "Processes payments via API")

Step 6: Zoom Into Containers

Double-click on your main system to dive into the Container level:

  1. Add containers like "Web Application", "API Server", "Database"
  2. Show how they communicate with each other
  3. Connect them to external systems

Next Steps

Congratulations! You've created your first architecture diagram. Here's what to explore next:

Tips for Success

  • Start high-level: Begin with System Context before diving into details
  • Use clear names: Name systems and containers descriptively
  • Add descriptions: Future you (and your team) will thank you
  • Iterate: Architecture documentation is a living thing - update it as your system evolves