Developers

Build with Faros

Start by connecting an edge and using live resources. Then follow the interfaces that match your work: CLI commands, workspace APIs, provider controllers, portal surfaces, or MCP tools.

Start the quickstart Browse all docs
  • kubectl-faros CLI
  • Kubernetes-style APIs
  • Provider contract
  • MCP integration

First run

Get from installation to a connected edge.

The quickstart follows one complete path through the platform instead of asking you to learn every subsystem first.

Step 1

Install the CLI

Install kubectl-faros through krew, from a release binary, or from source, then verify the plugin is available.

Install Faros

Step 2

Select a workspace

Log in with the configured authentication flow, select an organization and workspace, and keep credentials in the local kubeconfig.

Review login

Step 3

Connect an edge

Create a Kubernetes or Linux edge, run the generated join command, and use kubectl or SSH through the hub's reverse tunnel.

Use edge commands

Step 4

Connect an MCP client

Ask the CLI for an aggregate or per-edge MCP URL and use the generated setup for a supported client.

Configure MCP

Provider development

Add a capability through a stable set of sockets.

A provider can implement only the pieces it needs. The same packaging and lifecycle apply to the providers that ship in Faros and the ones you build.

Contract

Start with anatomy and lifecycle

Learn how CatalogEntry registration, initialization, API publication, serving, heartbeat, readiness, and tenant enablement fit together.

Read provider anatomy

Resources

Define APIs and permissions

Publish resource schemas through an APIExport, declare permission claims, and consume workspace APIs from controllers.

Define the API

Interfaces

Serve portal UI and MCP tools

Mount a provider micro-frontend in the portal, proxy backend routes through the hub, and expose tools through the tenant's aggregate MCP endpoint.

Build the UI

Operations

Package and deploy independently

Build the provider binary and image, package its chart, expose health and readiness, and onboard it to a hub.

Package a provider

Task-oriented reference

Go directly to the subsystem you are working on.

The documentation is organized around commands, deployment, provider development, concepts, and security rather than a single linear manual.

Operate

CLI reference

Use commands for authentication, workspaces, edges, SSH, MCP, and the local edge agent.

Browse commands

Deploy

Self-hosting guides

Deploy the hub with Helm and choose ingress, TLS, authentication, and connectivity appropriate for your environment.

Browse deployment guides

Secure

Security and tenancy

Review workspace membership, roles, service accounts, platform administration, OIDC, and static-token authentication.

Browse security guides

Discover

Provider catalog

See the providers present in the repository, their resource APIs, their MCP tools, and their portal surfaces.

Browse capabilities

Build in the open

Use the docs, inspect the source, and trace the contracts end to end.

Faros development happens in the public repository. The documentation links the user-facing workflows to the provider and control-plane architecture behind them.

Open the documentation View the repository