# Kloud Workspace

> 🔋 A batteries-included pre-configured development workspace inside a Docker container

## Table of Contents

### Get Involved

- [Contribute](https://ws.kloudkit.com/contribute.md): Get involved with Kloud Workspace — report bugs, improve functionality, and contribute to this open-source development workspace.

### Editor

- [Aliases](https://ws.kloudkit.com/editor/aliases.md): Built-in shell aliases in Kloud Workspace that shorten long, common commands into convenient keywords, plus how to define your own.
- [Authentication](https://ws.kloudkit.com/editor/authentication.md): Configure Kloud Workspace's opt-in authentication or integrate an external provider — the default deployment requires no authentication.
- [VS Extensions](https://ws.kloudkit.com/editor/extensions.md): Manage VS Code extensions in Kloud Workspace, including Marketplace terms and how to pre-install extensions in your deployment.
- [Additional Features](https://ws.kloudkit.com/editor/features.md): Opt-in features let you install and configure extra packages and tooling in Kloud Workspace on demand, keeping the base image lean.
- [Port Forwarding](https://ws.kloudkit.com/editor/port-forwarding.md): Expose ports from a Kloud Workspace container externally by configuring port forwarding around Docker's default network isolation.
- [Settings](https://ws.kloudkit.com/editor/settings.md): Customize the VS Code editor in Kloud Workspace with JSON-based settings, separate from environment-variable configuration.
- [Storage](https://ws.kloudkit.com/editor/storage.md): Persist data beyond a container's lifecycle in Kloud Workspace, working around Docker's ephemeral, stateless default storage.
- [Terminal](https://ws.kloudkit.com/editor/terminal.md): The Kloud Workspace terminal runs on zsh with a Starship prompt, rich colorization, and sensible defaults for a productive shell.
- [Theme & Fonts](https://ws.kloudkit.com/editor/theme-and-fonts.md): Kloud Workspace ships the Catppuccin Frappe palette and curated fonts for a warm, readable theme across the editor and colored output.

### Settings

- [Autoload Scripts](https://ws.kloudkit.com/settings/autoload-scripts.md): Personalize Kloud Workspace startup with autoload scripts that run your own installation and configuration steps beyond the defaults.
- [Configuration](https://ws.kloudkit.com/settings/configuration.md): Configure Kloud Workspace through environment variables, following a convention-over-configuration approach with sensible defaults.
- [TLS & Certificates](https://ws.kloudkit.com/settings/tls.md): Enable HTTPS and install custom CA certificates in Kloud Workspace to secure the editor, terminal, and browser tooling end-to-end.
- [Secrets](https://ws.kloudkit.com/settings/secrets.md): Manage sensitive credentials in Kloud Workspace with the ws-cli secrets command — encrypt passwords, API keys, and SSH keys instead of storing plaintext.
- [Seed](https://ws.kloudkit.com/settings/seed.md): Project files and secrets from a durable seed directory onto the workspace filesystem on every boot, within an ownership boundary.

### Tools

- [Tools](https://ws.kloudkit.com/tools/overview.md): An overview of the CLI tools pre-installed in Kloud Workspace, their licenses, and the custom configurations that enhance them.
- [Ansible](https://ws.kloudkit.com/tools/ansible.md): Ansible comes ready in Kloud Workspace for automating configuration management, deployment, and orchestration with declarative YAML.
- [APT Manager](https://ws.kloudkit.com/tools/apt.md): Kloud Workspace's custom APT setup delivers flexible, efficient package management that avoids unnecessary installs and protects user files.
- [C/C++ ](https://ws.kloudkit.com/tools/cpp.md): Add a full C and C++ compile-debug-build toolchain to Kloud Workspace with the opt-in cpp feature for performance-critical work.
- [Claude Code](https://ws.kloudkit.com/tools/claude.md): Claude Code comes pre-installed in Kloud Workspace as both a system-wide CLI and a VS Code extension, ready to use out of the box.
- [Cloudflared ](https://ws.kloudkit.com/tools/cloudflared.md): Expose a Kloud Workspace to the internet with Cloudflare Tunnel — an outbound-only connection needing no inbound ports or public IP.
- [Docker in Workspace](https://ws.kloudkit.com/tools/docker.md): Run Docker inside a Kloud Workspace container, with the trade-offs and alternative approaches for Docker-in-Docker workflows.
- [.NET ](https://ws.kloudkit.com/tools/dotnet.md): Install the .NET SDK, runtime, and ASP.NET Core runtime in Kloud Workspace with the opt-in dotnet feature for cross-platform C# development.
- [Git](https://ws.kloudkit.com/tools/git.md): Git in Kloud Workspace ships with sane defaults and useful aliases out of the box, plus guidance for customizing your workflow.
- [Go](https://ws.kloudkit.com/tools/go.md): Go comes pre-installed in Kloud Workspace with a full development toolchain — runtime, compiler, and tooling ready out of the box.
- [Helm](https://ws.kloudkit.com/tools/helm.md): Helm comes pre-installed in Kloud Workspace with auto-completion, the helm diff plugin, and Kubernetes VS Code extensions, ready to use.
- [Image Extras ](https://ws.kloudkit.com/tools/image-extras.md): An opt-in bundle of container-image tools for Kloud Workspace — generate an SBOM, scan images for vulnerabilities, and inspect layers.
- [Kind](https://ws.kloudkit.com/tools/kind.md): Kind (Kubernetes IN Docker) in Kloud Workspace runs local Kubernetes clusters in Docker containers for testing and local development.
- [Python](https://ws.kloudkit.com/tools/python.md): Kloud Workspace ships a finely-tuned Python 3.11 toolchain — pip, the fast uv package manager, auto venv activation, ruff, and Pyrefly.
- [Rust ](https://ws.kloudkit.com/tools/rust.md): Add Rust to Kloud Workspace with the opt-in feature — a systems language built for performance, reliability, and memory safety.
- [SSH](https://ws.kloudkit.com/tools/ssh.md): Kloud Workspace includes standardized, user-friendly SSH configurations for connecting to remote servers, in /etc/ssh/ssh_config.
- [`ws-cli` *(alias: `ws`)*](https://ws.kloudkit.com/tools/ws-cli.md): ws-cli is the CLI companion for Kloud Workspace — a suite of helper commands to navigate, manage, and automate your workspace.

### Other

- [Changelog](https://ws.kloudkit.com/changelog.md): Release notes for Kloud Workspace, generated from commit history of each tagged release
- [Contribution Workflow & Style Guides](https://ws.kloudkit.com/contribute/contribution-workflow.md): The step-by-step workflow for contributing to Kloud Workspace — branching, commits, and pull requests, governed by the project Code of Conduct.
- [Contributor Covenant Code of Conduct](https://ws.kloudkit.com/contribute/code-of-conduct.md): The KloudKIT Code of Conduct — our pledge to keep the Kloud Workspace community a harassment-free, welcoming space for every contributor.
- [Development Environment](https://ws.kloudkit.com/contribute/development-environment.md): Guidelines and setup for contributing to Kloud Workspace, from the Code of Conduct to preparing your local development environment.
- [Getting Started](https://ws.kloudkit.com/pages/getting-started.md): Get started with Kloud Workspace — system requirements and the quickest path to running your pre-configured development workspace.
- [Kloud Workspace](https://ws.kloudkit.com/pages.md): Run a customized, pre-configured VS Code workspace (powered by Coder) on Docker, Kubernetes, or OpenShift, in the browser or via SSH.
- [Metrics](https://ws.kloudkit.com/editor/metrics.md): Enable Kloud Workspace's built-in Prometheus-compatible metrics exporter to expose resource and session telemetry for your running workspace.
- [Save the browser clipboard to a file](https://ws.kloudkit.com/partials/commands.md)
- [Security Advisory](https://ws.kloudkit.com/contribute/security-advisory.md): How to responsibly report security vulnerabilities in Kloud Workspace privately, rather than through public GitHub issues.
- [Untitled](https://ws.kloudkit.com/partials/changelog.md)
- [Untitled](https://ws.kloudkit.com/partials/dependencies.md)
- [Untitled](https://ws.kloudkit.com/partials/deprecated-variables.md)
- [Untitled](https://ws.kloudkit.com/partials/environment-variables.md)
- [Untitled](https://ws.kloudkit.com/partials/feature-not-included.md)
- [Untitled](https://ws.kloudkit.com/partials/extensions.md)
- [Untitled](https://ws.kloudkit.com/partials/fonts.md)
- [Untitled](https://ws.kloudkit.com/partials/fs-manifest.md)