Installation & Setup

Get Lattice Engine up and running in minutes. Choose your preferred installation method and start building AI-powered applications.

10 minutesBeginner friendlyMultiple platforms

System Requirements

Node.js Environment
  • Node.js 16.0.0 or higher
  • npm 7.0.0 or higher (or Yarn 1.22+)
  • Git 2.20.0 or higher
  • At least 2GB RAM
  • 500MB disk space
Python Environment
  • Python 3.8.0 or higher
  • pip 20.0.0 or higher
  • Git 2.20.0 or higher
  • At least 2GB RAM
  • 500MB disk space
Docker Environment
  • Docker 20.10.0 or higher
  • Docker Compose 1.29.0 or higher
  • At least 4GB RAM allocated to Docker
  • 2GB disk space for images

Installation Methods

NPM (Recommended)
Install via npm for Node.js projects

Installation Commands

npm install -g @lattice/cli
npm install @lattice/engine
npm install @lattice/sdk

Verify Installation

lattice --version

Configuration Steps

1
Create Account
Sign up for a free Lattice Engine account
Visit https://app.project-lattice.site/register

You'll receive an API key after email verification

2
Configure API Key
Set up your API key for authentication
lattice config set-api-key YOUR_API_KEY

Store your API key securely in your environment

3
Initialize Project
Create your first Lattice project
lattice init my-project

This creates a .lattice directory with configuration

4
Verify Installation
Test your installation with a simple command
lattice status

Should show 'Connected' and your account details

Common Issues

Command not found: lattice

Ensure the global installation completed successfully. Try reinstalling with sudo/admin privileges.

Permission denied during installation

Use sudo for global installations or install locally in your project directory.

API key authentication failed

Verify your API key is correct and has the necessary permissions. Check your account status.

Node.js version incompatible

Update Node.js to version 16.0.0 or higher using nvm or your package manager.

Next Steps

Quick Start Guide
Learn the basics in 5 minutes
Core Concepts
Understand mutations and specifications
API Documentation
Explore the complete API reference
VSCode Extension
Install the IDE extension for better experience

Need Help?

Having trouble with installation? Our community is here to help.