Skip to content
faros Docs
Sections
Open console

Enter a topic to search documentation.

    Command reference

    Every faros command with its flags and examples, generated from the CLI.

    Synopsis

    faros connects Kubernetes clusters and Linux servers behind NAT to one hub, and gives every team an isolated workspace with its own APIs, RBAC and providers on top.

    Typical session:

    Terminal
    faros login --hub-url https://hub.example.com   # OIDC in the browser
faros use                                        # pick an org and workspace
faros edge list                                  # what is connected
faros connect my-cluster                         # point kubectl at an edge
faros ssh my-server                              # shell on a Linux edge
faros whoami                                     # where am I, what can I do

    Every command talks to the hub as you, with your workspace RBAC. Run ‘faros <command> –help’ for details and ‘faros completion –help’ for shell completion.

    Options

    TEXT
      -h, --help                       help for faros
      --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 agent — Run, install or upgrade the edge agent on a cluster or server
    • faros app — Manage App Studio projects: list, create, status, sync, promote, publish
    • faros commit — Record local git commits through faros (code__commit_files)
    • faros completion — Generate the autocompletion script for the specified shell
    • faros connect — Point kubectl at a Kubernetes edge
    • faros dev — Manage development environment for faros
    • faros disconnect — Point kubectl back at the hub workspace
    • faros edge — Create, list, inspect and remove edges (clusters and servers)
    • faros env — Print shell exports for calling the hub as you
    • faros init — Run a faros hub in-process (server side, not a client command)
    • faros install — Install the faros agent
    • faros login — Log in to a faros hub (browser OIDC flow, or a static token)
    • faros logout — Forget the hub credentials on this machine
    • faros mcp — MCP endpoints for AI clients (Claude Code, Cursor, Codex)
    • faros org — Organizations you belong to, and who is in them
    • faros sandbox — Drive a development-mode instance: sync, exec, logs, restart, status
    • faros skills — Install agent skills from the faros repository into Claude Code and Codex
    • faros ssh — Open an SSH session to a Linux server edge via the hub
    • faros token — Print a bearer token for the hub (refreshing it when needed)
    • faros use — Switch the active organization and workspace
    • faros version — Print version information
    • faros whoami — Show who you are logged in as, and where kubectl points
    • faros workspace — Workspaces of an organization, and who is in them