faros Documentation
CLI Reference
Every kedge command — authentication, organizations, edges, agents, SSH, MCP.
The kedge CLI is a kubectl plugin (when installed via krew, it’s kubectl kedge; the standalone binary just drops the kubectl prefix). All commands below use the kubectl kedge form.
Global flags
| Flag | Description |
|---|---|
--kubeconfig <path> | Path to the kubeconfig to read and write. Defaults to $KUBECONFIG or ~/.kube/config. |
That’s the only global flag. Everything else (--hub-url, --token, --insecure-skip-tls-verify, …) lives on the individual commands that need it. Login always writes to a kubeconfig context named kedge.
Command summary
| Command | What it does |
|---|---|
login | Authenticate with the hub (OIDC browser flow or static token). |
use | Switch the active organization and workspace (interactive picker or flags). |
connect <edge> | Point your kubeconfig at an edge cluster; connect : returns to the hub root. |
edge create <name> | Register a new edge and print the agent join guide. |
edge list | List all edges with type, phase, and connection status (list/ls also work top-level). |
edge get <name> | Show details for a specific edge. |
edge join-command <name> | Re-print the agent install guide with the join token. |
edge upgrade <name> | Show upgrade instructions when the agent version is behind the CLI. |
edge delete <name> | Remove an edge. |
kubeconfig edge <name> | Generate a kubeconfig that proxies kubectl through the hub. |
agent ... | Run, install, and upgrade the edge agent (run, join, install, uninstall, upgrade). |
install | One-shot agent install (systemd unit or Kubernetes manifests) from a join token. |
ssh <name> | Open an SSH session (or run a single command) on a server-type edge. |
mcp url | Print an MCP endpoint for AI agents (--mcpserver-name aggregate or --edge per-edge). |
apply -f <file> | Apply a kedge resource from a YAML file. |
get <resource> | List edges, workloads, or placements in the current workspace. |
version | Print CLI version, commit, build date, and platform. |
dev init / dev update / dev delete | Create, upgrade, or tear down a local kind-based dev hub (init has alias create). |
init | Run an in-process kedge hub (server bootstrap — for development, not the CLI workflow). |
Pick a command from the sidebar for the full reference.
Login & Authentication →
kubectl kedge login — OIDC browser flow or static token.
Organizations & Workspaces →
kubectl kedge use and connect — switch orgs, workspaces, and edge clusters.
Edges →
Register, list, inspect, upgrade, and remove edges.
Agent Commands →
Run, install, and upgrade the kedge agent on edges.
SSH →
Reach server-mode edges through the hub's reverse tunnel.
MCP for AI Agents →
Expose your clusters and servers as Model Context Protocol servers.