Browse OpenForge documentation
/oss/en/clusterdeck/getting-started

ClusterDeck Getting Started

macOS development setup and the Profile-oriented SSH/kubeconfig connection flow.

ClusterDeck Getting Started

The initial scope is macOS-first and uses Tauri 2, Rust, React, and TypeScript.

Running from source is the recommended path.

pnpm install
pnpm tauri dev

Alternatively, download the macOS (Apple Silicon aarch64 or Intel x64) .dmg from the v0.5.0 release and run it directly. There is no Apple Developer ID certificate yet, so macOS shows an "unidentified developer" warning on first launch — right-click the app and choose Open to run it anyway.

Validate both frontend and Rust backend:

pnpm build
cargo check --manifest-path src-tauri/Cargo.toml

Connection flow

  1. Create a stable environment Profile.
  2. Discover hosts by CIDR or explicit address.
  3. Probe SSH connectivity.
  4. Optionally bootstrap a public key.
  5. Configure ProxyJump when a bastion is required.
  6. Fetch kubeconfig from a control-plane host.
  7. Normalize endpoint and context names around the Profile.
  8. Verify the Kubernetes API using the local Profile kubeconfig.

Never place real passwords, private keys, kubeconfigs, tokens, certificates, or infrastructure addresses in public documentation, issues, tests, or screenshots.