Get up and running with Kloudlite in four simple steps
Choose Machine
Create Environment
Create Workspace
Start Coding
A work machine is your dedicated development environment that runs your workspaces. Select a machine type from the available options in your installation based on your resource requirements.
Machine Types
Your installation administrator configures the available machine types. Choose one that matches your development workload - you can always create additional work machines with different specifications later.
Environments are isolated spaces where your applications and services run. Think of them as different stages like development, staging, or production - each with its own services and configurations.
Navigate to Environments
Click on "Environments" in your dashboard
Click "Create Environment"
This opens a dialog to create your new environment
Enter Environment Name
Choose a name like "development" or "staging" (lowercase letters, numbers, and hyphens only, max 63 characters)
Create Environment
Click the create button and your environment will be ready in seconds
What Happens Next?
After creation, you can add services to your environment using docker-compose files or manually. Environments are initially inactive to save resources - activate them when you're ready to use them.
Once created, your environment has several sections to manage different aspects:
Add and manage your application services using docker-compose. View service details like DNS names, IPs, and ports. Set up service intercepts to route traffic to your workspace for debugging.
Environment Variables: Store key-value pairs for configuration (API keys, database URLs, etc.).
Config Files: Upload configuration files that services can mount and use.
Configure environment properties, access control, network policies, and security settings. Manage who can access the environment and how services communicate.
The easiest way to add services to your environment is using docker-compose. Click on your environment, go to the Services tab, and click the edit button to open the composition editor.
Example: Adding a PostgreSQL database and Redis cache
services:
postgres:
image: postgres:16
environment:
POSTGRES_PASSWORD: devpassword
POSTGRES_DB: myapp
ports:
- "5432:5432"
volumes:
- postgres-data:/var/lib/postgresql/data
redis:
image: redis:7-alpine
ports:
- "6379:6379"
volumes:
- redis-data:/data
volumes:
postgres-data:
redis-data:Save the composition and Kloudlite will create the services in your environment. They'll be accessible via their service names (e.g., postgres, redis). Data will persist across Environment restarts.
A workspace is your Dev Container with different ways to access (VS Code Web, desktop IDEs via SSH, web terminal, AI assistants like Claude Code) and package management powered by Nix. All your code, tools, and configurations live here.
Navigate to Workspaces
Access the "Workspaces" section from your dashboard
Click "Create Workspace"
Start the workspace creation process
Enter Basic Information
Select Development Packages
Choose the tools and runtimes you need. Examples:
Choose Machine Type
Select the machine type you created earlier based on your resource needs
Connect to Environment (Optional)
Link your workspace to an environment for service access and integrations
Create Workspace
Click create and wait for your workspace to provision (usually takes 30-60 seconds)
Reproducible Environments
Kloudlite uses Nix package manager for declarative, reproducible package installations. Your exact package versions are preserved and can be shared across your team.
Kloudlite offers multiple ways to access your workspace. Choose the method that fits your workflow best.
Add this configuration to your ~/.ssh/config file:
Host your-workspace-name HostName workspace-your-workspace-name User kl ProxyJump kloudlite@localhost:2222 StrictHostKeyChecking no UserKnownHostsFile /dev/null
Replace your-workspace-name with your actual workspace name.
Install the Kloudlite VS Code extension and click the connection link from your workspace dashboard.
Connect using VS Code's built-in SSH Remote extension:
code --remote ssh-remote+your-workspace-name
These IDEs also support SSH remote connections. Use your workspace SSH config for seamless access.
Full VS Code IDE in your browser. No installation needed - just click and code!
Browser-based terminal with full shell access to your workspace.
Anthropic's AI coding assistant directly in your terminal
AI assistant for code generation and debugging
AI-powered code completion and assistance
Recommendation for Beginners
Start with VS Code Web for the easiest setup. No configuration needed - just click the link from your workspace dashboard and start coding immediately.
Learn how to set up your own Kloudlite installation for your team
Explore workspace settings, dotfiles, environment variables, and custom configurations
Deep dive into Nix package management, channels, and version pinning
Complete guide to the kl CLI tool commands
Start Small
Begin with a Development or General Purpose machine type. You can always scale up later.
Save Resources
Keep environments inactive when not in use and suspend workspaces to save resources.
Use Semantic Versioning
When installing packages, specify versions for reproducibility (e.g., nodejs@20.10.0).
Configure SSH Early
Set up your SSH config file early for seamless access across all desktop IDEs.
Leverage AI Assistants
Try Claude Code or other AI assistants for faster development and learning.
You're all set! Head to your dashboard and create your first workspace.