Skip to main content

​
lc setup

Configure your LocalCloud project interactively or create a new project from a template.

​
Usage

lc setup [template] [flags]

​
Arguments

  • template (optional) - Template name to create project from

​
Flags

FlagDescriptionDefault
--nameProject name (for template creation)template name
--forceOverwrite existing directoryfalse

​
Modes

​
1. Interactive Configuration (No Arguments)

When run without arguments in an existing project: 
lc setup
This launches the same interactive wizard as lc init --interactive, allowing you to:
  • Select project type
  • Choose components (Database, Vector Database, Cache, Storage)
  • Pick AI models
  • Configure services
Vector Database is presented as a separate option in the setup wizard, but uses the same PostgreSQL instance with pgvector extension for optimal performance.
The project must already be initialized with lc init before running lc setup without arguments.

​
2. Template Creation (With Template Name)

Create a new project from a template: 
lc setup chat
lc setup api-only --name my-api --port 8080

​
Available Templates

TemplateDescriptionServices
chatChatGPT-like interface with conversation historyOllama, PostgreSQL, Redis
code-assistantAI-powered code editor and assistantOllama, PostgreSQL, Redis, MinIO
transcribeAudio/video transcription serviceWhisper, PostgreSQL, MinIO
image-genAI image generation interfaceStable Diffusion, PostgreSQL, MinIO
api-onlyREST API without frontendOllama, PostgreSQL, Redis

​
Examples

​
Configure existing project

# In an initialized project
lc setup

​
Create chat application

lc setup chat
cd chat
# Project is ready with all services running!

​
Create API with custom settings

lc setup api-only \
  --name my-api \
  --port 8080 \
  --model mistral

​
Generate files without starting services

lc setup chat --skip-docker
# Manually start later with: lc start

​
Overwrite existing directory

lc setup chat --name existing-dir --force

​
Template Creation Process

When creating from a template, setup performs these steps:
  1. System Check
  • Verifies Docker is installed
  • Checks available RAM and disk space
  • Validates system requirements
  1. Interactive Configuration (if needed)
  • Project name (if not provided)
  • AI model selection
  • Port allocation
  1. File Generation
  • Creates project structure
  • Generates configuration files
  • Copies template files
  • Substitutes variables
  1. Service Startup (unless --skip-docker)
  • Pulls required Docker images
  • Starts all services
  • Waits for health checks
  1. Success Summary
  • Shows service URLs
  • Displays next steps
  • Provides example commands

​
Template Structure

Templates include: 
template/
├── docker-compose.yml      # Service definitions
├── .env.template          # Environment variables
├── README.md              # Project documentation
├── backend/               # Backend code (if applicable)
├── frontend/              # Frontend code (if applicable)
└── config/                # Configuration files

​
Model Selection

During setup, you can choose from recommended models based on your hardware:

​
For Limited Resources (8GB RAM)

  • qwen2.5:3b - Fast and efficient
  • phi3 - Microsoft’s compact model
  • gemma2:2b - Google’s tiny model

​
For Standard Systems (16GB RAM)

  • llama2 - Meta’s popular model
  • mistral - Great for coding
  • codellama - Specialized for code

​
For High-End Systems (32GB+ RAM)

  • mixtral:8x7b - Powerful MoE model
  • llama3:70b - Large language model
  • qwen2.5:32b - Advanced reasoning

​
Port Management

LocalCloud automatically manages ports to avoid conflicts:
  1. Default Ports:
  • API: 3001
  • Frontend: 3000
  • AI: 11434
  • PostgreSQL: 5432
  • Redis: 6379
  • MinIO: 9000/9001
  1. Automatic Assignment: If defaults are in use, finds next available port
  2. Manual Override: Use flags to specify custom ports

​
Error Handling

​
No project found

Error: no LocalCloud project found. Run 'lc init' first
Solution: Initialize a project first with lc init

​
Template not found

Error: template 'unknown' not found
Solution: Use lc templates list to see available templates

​
Insufficient resources

Error: insufficient RAM: required 8GB, available 4GB
Solution: Choose a smaller model or free up system resources

​
Port already in use

Error: port 3000 is already in use
Solution: Use --port flag to specify a different port

​
Advanced Usage

​
Custom Template Variables

Templates can use these variables:
  • {{.ProjectName}} - Project name
  • {{.APIPort}} - API port number
  • {{.FrontendPort}} - Frontend port
  • {{.ModelName}} - Selected AI model
  • {{.DatabaseURL}} - PostgreSQL connection string
  • {{.RedisURL}} - Redis connection string

​
Environment Configuration

Generated .env file includes: 
PROJECT_NAME={{.ProjectName}}
API_PORT={{.APIPort}}
FRONTEND_PORT={{.FrontendPort}}
DATABASE_URL=postgresql://localcloud:localcloud@localhost:5432/localcloud
REDIS_URL=redis://localhost:6379
OLLAMA_URL=http://localhost:11434
AI_MODEL={{.ModelName}}
⌘I