Quick Start Guide

Get up and running with Kloudfarm in minutes. This guide walks you through account setup, project creation, and exploring your first architecture visualization.

This guide will help you get started with Kloudfarm and create your first architecture visualization in minutes.

Creating Your Account

  1. Visit kloudfarm.io/signup
  2. Enter your email address and create a password
  3. Complete your profile with company and role information
  4. Verify your email address with the link sent to your inbox

Account Creation Process

Accessing the Platform

Once your account is activated, you can access Kloudfarm through:

  • Web Application: app.kloudfarm.io
  • Desktop Application: Available for Windows, macOS, and Linux
  • Command Line Interface: For automation and CI/CD integration

Creating Your First Project

Kloudfarm offers multiple pathways to create your first project:

Method 1: Connect Repository

For existing codebases stored in Git repositories:

  1. From the dashboard, click Create Project
  2. Select Connect Repository
  3. Choose your Git provider (GitHub, GitLab, Bitbucket)
  4. Authenticate and select the repository you wish to analyze
  5. Configure your analysis settings
  6. Click Create Project to begin analysis

Connect Repository

Method 2: Local Analysis

For codebases stored locally or with restricted access:

Local Analysis Local Analysis

  1. Download the appropriate Kloudfarm client for your platform:
  2. Install and launch the application
  3. Sign in with your Kloudfarm credentials
  4. Click New Project and select your local codebase

Project Directory Selection

  1. Configure analysis settings and click Analyze Project Directory Selection

Method 3: AI-Assisted Design

For new projects or conceptual architecture planning:

  1. From the dashboard, click Create Project
  2. Select Design with AI
  3. Describe your system requirements in natural language
    Example: "Design a microservices architecture for an e-commerce platform 
    with user authentication, product catalog, and payment processing"
    
  4. Review the generated architecture
  5. Customize components as needed
  6. Save your project

AI-Assisted Design

Exploring Your Architecture

Once analysis completes (typically within minutes):

  1. Your architecture diagram will appear in the visualization canvas
  2. Use the navigation controls to zoom and pan
  3. Click on components to view detailed information
  4. Use the search function to find specific elements
  5. Toggle between different visualization modes using the View menu

Exploring Architecture

Sharing with Your Team

To collaborate with colleagues:

  1. Click the Share button in the top-right corner
  2. Enter email addresses of team members
  3. Choose access levels (View, Edit, Admin)
  4. Click Send Invites

Invited users will receive an email with a link to access your project.

Next Steps

Now that you've created your first project, explore these features:

Need help? Contact our support team at support@kloudfarm.io.