# faros dev init

Initialize a local faros environment (hub kind cluster + optional workers)

Source: https://faros.sh/docs/reference/cli/commands/dev-init/

<!-- Generated by scripts/sync-cli-docs.py from faroshq/faros docs/cli. Do not edit by hand; run `make sync-cli-docs`. -->

## Synopsis

Initialize a local faros environment using kind clusters.

This command will:

- Create a hub kind cluster running the faros hub
- Create N worker (agent) kind clusters when --worker-count > 0
- Add faros.localhost to /etc/hosts (with sudo prompts if needed)
- Install the faros-hub Helm chart (default: OCI chart from ghcr.io)
- Configure necessary port mappings (9443, 8080)

The default is hub-only (--worker-count 0), suitable for end users who just
want to run a local faros instance. Developers working on agents should set
--worker-count to the number of edges they want to simulate.

The hub chart can be sourced from:

- OCI registry (default): oci://ghcr.io/faroshq/charts/faros-hub
- Local filesystem: --chart-path ./deploy/charts/faros-hub
- Custom OCI registry: --chart-path oci://custom.registry/charts/faros-hub

```bash
faros dev init [flags]
```

## Examples

```bash
  # Initialize a hub-only local faros environment (default, for end users)
  faros dev init

  # Hub + 1 worker kind cluster (typical developer setup)
  faros dev init --worker-count 1

  # Hub + 3 worker kind clusters
  faros dev init --worker-count 3

  # Use a local chart for development
  faros dev init --chart-path ../deploy/charts/faros-hub

  # Pin chart version
  faros dev init --chart-version 0.1.0
```

## Options

```text
      --agent-chart-path string           Helm chart path or OCI registry URL for agent (default "oci://ghcr.io/faroshq/charts/faros-agent")
      --agent-cluster-name string         Name of the agent cluster in dev mode (default "faros-agent")
      --api-server-port int               Kubernetes API server port for hub kind cluster (change if 6443 is already in use) (default 6443)
      --chart-path string                 Helm chart path or OCI registry URL for hub (default "oci://ghcr.io/faroshq/charts/faros-hub")
      --chart-version string              Helm chart version (default "0.0.51")
      --dex-http-port int                 Host port for the Dex NodePort mapping (Dex serves HTTPS on this port; default 5554) (default 5554)
  -h, --help                              help for init
      --hub-cluster-name string           Name of the hub cluster in dev mode (default "faros-hub")
      --hub-http-port int                 HTTP port for faros hub (change if 8080 is already in use) (default 8080)
      --hub-https-port int                HTTPS port for faros hub (change if 9443 is already in use) (default 9443)
      --image string                      faros hub image to use in dev mode (default "ghcr.io/faroshq/faros-hub")
      --image-pull-policy string          Image pull policy for the hub (use Never when the image is pre-loaded into kind) (default "IfNotPresent")
      --kcp-https-port int                Host port for the kcp front-proxy NodePort mapping (default 7443) (default 7443)
      --kind-network string               kind network to use in dev mode (default "faros-dev")
      --tag string                        faros hub image tag to use in dev mode
      --wait-for-ready-timeout duration   Timeout for waiting for the cluster to be ready (default 2m0s)
      --with-dex                          Deploy Dex as OIDC identity provider into the hub kind cluster
      --with-external-kcp                 Deploy kcp via Helm into the hub kind cluster instead of using embedded kcp
      --worker-count int                  Number of worker (agent) kind clusters to create. Default 0 = hub-only (local user). Use 1+ for development/tests; >1 names clusters <agent-cluster-name>-1, -2, …
```

## Inherited options

```text
      --insecure-skip-tls-verify   Skip TLS certificate verification when talking to the hub
      --kubeconfig string          Path to the kubeconfig file (default: $KUBECONFIG, then ~/.kube/config)
```

## See also

- [faros dev](https://faros.sh/docs/reference/cli/commands/dev/) — Manage development environment for faros