frankctl

Terminal-first CLI for the Frank Low-Code Pipeline platform — scriptable access to sources, streams, transforms, pipelines, backing datasets, and AI assistance.

Install

npm install -g @aiaiai-pt/frankctl
frankctl --help

Requires Node.js >= 18. The binary is frankctl.

Quickstart

frankctl auth login            # authenticate against your Frank instance
frankctl --api-url https://frank.example.com sources list
frankctl pipelines apply -f pipeline.yaml

Full command reference: the Frank docs and frankctl <command> --help.

Develop from source

npm install
npm run build
npm link
frankctl --help

Scope

• frankctl status
• frankctl auth login|logout|status|token
• frankctl config set|get|list
• frankctl pipelines list|get|validate|apply|export
• frankctl sources list|get|create|update|delete|discover|sync|logs|history
• frankctl backing-datasets list|get|create|update|delete (alias: frankctl bd)
• frankctl sources streams list|set|refresh-schema
• frankctl transforms list|get|runs|logs|trigger
• frankctl runs get|wait|cancel
• frankctl patterns list|get|validate-params|register
• frankctl schedules list|get|set|delete|pause|resume|trigger (source-scoped)
• frankctl datasets list|preview|snapshots
• frankctl ai compose-pipeline|generate-transform|review-sql|fix-ci-failure|suggest|publish-transform

Config files for sources create|update, backing-datasets create|update, and sources streams set accept YAML or JSON (use - to read stdin).

Declarative apply (pipelines apply -f)

frankctl pipelines apply -f vertical.yaml provisions a complete Source + Pipeline + BackingDataset triple from a single multi-doc YAML file. Docs use the kubectl-style envelope (apiVersion: frank.platform/v1, kind:, metadata.name:, spec:). The CLI sorts by kind (Source → Pipeline → BackingDataset), resolves cross-doc name references to UUIDs, and POSTs each doc with ?if-not-exists=true. frankctl pipelines export <id> -o yaml round-trips an existing pipeline back to a multi-doc YAML file ready for adoption into git. See ../docs/guides/cli.md for the full reference.

Environment

• FRANKCTL_API_URL — Frank API base (default http://localhost:8000)
• FRANKCTL_KEYCLOAK_URL — Keycloak base (default http://localhost:8180)
• FRANKCTL_KEYCLOAK_REALM — realm (default frank)
• FRANKCTL_CLIENT_ID — OAuth client id (default frank-low-code for user flows, frank-api for service account)
• FRANKCTL_CLIENT_SECRET — client secret (service account only)
• FRANKCTL_PROFILE — active config profile
• FRANKCTL_TOKEN — bypass token store entirely
• FRANK_DEV_MODE=true + FRANKCTL_TENANT_ID=<uuid> — forward X-Tenant-ID header (required today for transforms and source sync routes)
• PATTERN_WEBHOOK_SECRET — HMAC-SHA256 signing key for frankctl patterns register (CI only; command exits 6 when unset)