---
slug: setup
title: Setup
description: Install Holos and build the initial structure.
sidebar_position: 20
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import RenderPlatformDiagram from '@site/src/diagrams/render-platform-sequence.mdx';

# Setup

## Overview

This tutorial will guide you through the installation of Holos and its
dependencies, as well as the initialization of a minimal Platform that you can
extend to meet your specific needs.

## Installing Holos

Holos is distributed as a single file executable that can be installed in a
couple of ways.

### Releases

Download `holos` from the [releases] page and place the executable into your
shell path.

### Go Install

```shell
go install github.com/holos-run/holos/cmd/holos@latest
```

### Dependencies

Holos integrates with the following tools that should be installed to enable
their functionality.

- [Helm] to fetch and render Helm chart Components.
- [Kubectl] to [kustomize] components.

Holos is tested with Helm version `v3.16.2`.  Please try upgrading helm if you
encounter `Error: chart requires kubeVersion ...` errors.

## Next Steps

You've got the structure of your platform configuration in place. Continue on to
[Hello Holos] where you'll learn how easy it is to manage a Helm chart with
holos.

[Helm]: https://github.com/helm/helm/releases
[Kubectl]: https://kubernetes.io/docs/tasks/tools/
[kustomize]: https://kustomize.io/
[Local Cluster]: ../topics/local-cluster.mdx
[Hello Holos]: ./hello-holos.mdx
[releases]: https://github.com/holos-run/holos/releases
[k3d]: https://k3d.io/
[OrbStack]: https://docs.orbstack.dev/install
[Docker]: https://docs.docker.com/get-started/get-docker/
