Skip to main content

Migrating to defakto-cli

The defakto CLI is the Defakto-branded successor to spirlctl, built from the same codebase and released in lockstep at the same version. Every command, flag, and feature is identical; only the branding differs. spirlctl continues to work, but we recommend defakto for new installations.

To migrate, install defakto-cli and account for the differences below.

What changes

spirlctldefakto
Command namespirlctldefakto
Default API endpointapi.spirl.comapi.defakto.security
Login (SSO) domainauth.api.spirl.comauth.api.defakto.security
Environment variablesSPIRL_ prefixDEFAKTO_ prefix
Config and credentials~/.spirl~/.defakto
dev-id socketunix:/tmp/spirl/devid/workload.sockunix:/tmp/defakto/devid/workload.sock
Attribution headersx-spirl-client, x-spirl-client-versionx-defakto-client, x-defakto-client-version
Audit client namespirlctldefakto-cli

Anywhere the documentation shows spirlctl <command>, run defakto <command> instead.

Migration notes

  • Log in again. defakto keeps its configuration and login session in ~/.defakto, so your spirlctl session does not carry over — run defakto login after installing. If you customized ~/.spirl/config.json, copy it to ~/.defakto/config.json.
  • Enterprise SSO. Login redirects go through auth.api.defakto.security, so your IDP must allow-list the new CLI Redirect URL. See Enterprise SSO Configuration.
  • Environment variables. Rename SPIRL_-prefixed variables to DEFAKTO_, e.g. SPIRL_ENDPOINT becomes DEFAKTO_ENDPOINT.
  • Network egress. If your network restricts outbound traffic, allow the defakto.security endpoints. If your egress proxy filters or logs request headers, account for the x-defakto-client and x-defakto-client-version headers.
  • dev-id workloads. defakto dev-id serve listens on unix:/tmp/defakto/devid/workload.sock by default; update workloads that connect to the old socket path. dev-id configuration and fetched SVIDs live under ~/.defakto/dev-id/.
  • Audit and SIEM. API activity from the defakto CLI is attributed to the client name defakto-cli in audit events and the Console. Update SIEM rules or saved filters that match on spirlctl.