Skip to content

CLI Reference

Global usage

bash
iflowkit [--profile {profileId}] [--log-level {trace|debug|info|warn|error}] [--log-format {text|json}] {command} [args]

Global flags

FlagDefaultDescription
--profile {profileId}active profileOverrides the active profile for the command.
--log-level {level}infoOne of trace, debug, info, warn, error.
--log-format {format}textOne of text, json.

Global flags must be placed before the command name.

help

bash
iflowkit help
iflowkit help profile
iflowkit help sync push

Shows root, command or subcommand help.

where

bash
iflowkit where

Shows local configuration locations and current profile context.

config

Developer preferences management.

config init

bash
iflowkit config init

Creates or overwrites config.json interactively.

config show

bash
iflowkit config show

Prints the current developer config.

config export

bash
iflowkit config export [--out {file.iflowkit}] [--overwrite]

Exports config.json as a .iflowkit archive.

config import

bash
iflowkit config import --file {file.iflowkit} [--overwrite]

Imports developer config from an archive.

profile

Customer profile management.

CommandUsage
profile initiflowkit profile init [--overwrite]
profile listiflowkit profile list
profile currentiflowkit profile current
profile showiflowkit profile show
profile useiflowkit profile use --id {profileId}
profile deleteiflowkit profile delete --id {profileId} --yes
profile exportiflowkit profile export --id {profileId} [--out {file.iflowkit}] [--overwrite]
profile importiflowkit profile import --file {*.iflowkit} [--overwrite]

tenant

CPI tenant service key management.

tenant import

bash
iflowkit tenant import --file {service-key.json} [--env dev|qas|prd]

Imports a CPI service key JSON file for the resolved profile.

tenant show

bash
iflowkit tenant show [--env dev|qas|prd]

Shows the stored tenant service key information for an environment.

tenant set

bash
iflowkit tenant set --env dev|qas|prd \
  --url {url} \
  --token-url {tokenUrl} \
  --client-id {id} \
  --client-secret {secret} \
  [--created-at {rfc3339}]

Sets tenant fields directly without importing a JSON file.

tenant delete

bash
iflowkit tenant delete --env dev|qas|prd --yes

Deletes a stored tenant service key.

sync

IntegrationPackage ↔ Git workflow management.

CommandPurpose
sync initInitialize a Git repository from DEV tenant package content.
sync pullRefresh local repo from CPI and push CPI state to Git.
sync pushPush local Git changes to CPI.
sync compareShow package differences between current branch and target environment branch.
sync deliverPromote changes between environment branches and update target tenant.
sync deploy statusInspect local deployment/transport records.

See Sync Commands for the detailed reference.