CLI reference
This page is generated by executing every public help path offline. Environment defaults are documented in Settings and environment.
justflow --help
usage: justflow [-h]
{worker,worker-server,api,serve,validate,graph,run,definitions,triggers,schema}
...
Justflow - Temporal-based workflow orchestration
positional arguments:
{worker,worker-server,api,serve,validate,graph,run,definitions,triggers,schema}
worker Run the Temporal worker (default)
worker-server Run the Temporal worker with liveness and readiness
endpoints
api Run ingress and the control/operations/configuration
API without a worker
serve Run the worker, ingress, and optional control API
validate Cross-validate all config layers
graph Render a workflow as an HTML diagram
run One-shot local run on a throwaway Temporal dev server
definitions Manage immutable workflow definitions
triggers Manage declared triggers
schema Manage authoring JSON Schemas
options:
-h, --help show this help message and exit
justflow worker --help
usage: justflow worker [-h] [--config-dir CONFIG_DIR]
[--temporal-address TEMPORAL_ADDRESS]
[--task-queue TASK_QUEUE]
[--deployment-name DEPLOYMENT_NAME]
[--build-id BUILD_ID]
[--artifact-digest ARTIFACT_DIGEST]
[--package-version PACKAGE_VERSION]
[--source-revision SOURCE_REVISION]
[--runtime-profile {RuntimeProfile.LOCAL,RuntimeProfile.PRODUCTION}]
[--log-level {DEBUG,INFO,WARNING,ERROR}]
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--temporal-address TEMPORAL_ADDRESS
--task-queue TASK_QUEUE
--deployment-name DEPLOYMENT_NAME
--build-id BUILD_ID
--artifact-digest ARTIFACT_DIGEST
--package-version PACKAGE_VERSION
--source-revision SOURCE_REVISION
--runtime-profile {RuntimeProfile.LOCAL,RuntimeProfile.PRODUCTION}
--log-level {DEBUG,INFO,WARNING,ERROR}
justflow worker-server --help
usage: justflow worker-server [-h] [--config-dir CONFIG_DIR]
[--temporal-address TEMPORAL_ADDRESS]
[--task-queue TASK_QUEUE]
[--deployment-name DEPLOYMENT_NAME]
[--build-id BUILD_ID]
[--artifact-digest ARTIFACT_DIGEST]
[--package-version PACKAGE_VERSION]
[--source-revision SOURCE_REVISION]
[--runtime-profile {RuntimeProfile.LOCAL,RuntimeProfile.PRODUCTION}]
[--log-level {DEBUG,INFO,WARNING,ERROR}]
[--host HOST] [--port PORT]
[--shutdown-grace-seconds SHUTDOWN_GRACE_SECONDS]
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--temporal-address TEMPORAL_ADDRESS
--task-queue TASK_QUEUE
--deployment-name DEPLOYMENT_NAME
--build-id BUILD_ID
--artifact-digest ARTIFACT_DIGEST
--package-version PACKAGE_VERSION
--source-revision SOURCE_REVISION
--runtime-profile {RuntimeProfile.LOCAL,RuntimeProfile.PRODUCTION}
--log-level {DEBUG,INFO,WARNING,ERROR}
--host HOST
--port PORT
--shutdown-grace-seconds SHUTDOWN_GRACE_SECONDS
justflow api --help
usage: justflow api [-h] [--config-dir CONFIG_DIR]
[--temporal-address TEMPORAL_ADDRESS]
[--task-queue TASK_QUEUE]
[--deployment-name DEPLOYMENT_NAME] [--build-id BUILD_ID]
[--artifact-digest ARTIFACT_DIGEST]
[--package-version PACKAGE_VERSION]
[--source-revision SOURCE_REVISION]
[--runtime-profile {RuntimeProfile.LOCAL,RuntimeProfile.PRODUCTION}]
[--log-level {DEBUG,INFO,WARNING,ERROR}] [--host HOST]
[--port PORT]
[--shutdown-grace-seconds SHUTDOWN_GRACE_SECONDS]
{schema} ...
positional arguments:
{schema}
schema Manage the public OpenAPI contract
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--temporal-address TEMPORAL_ADDRESS
--task-queue TASK_QUEUE
--deployment-name DEPLOYMENT_NAME
--build-id BUILD_ID
--artifact-digest ARTIFACT_DIGEST
--package-version PACKAGE_VERSION
--source-revision SOURCE_REVISION
--runtime-profile {RuntimeProfile.LOCAL,RuntimeProfile.PRODUCTION}
--log-level {DEBUG,INFO,WARNING,ERROR}
--host HOST
--port PORT
--shutdown-grace-seconds SHUTDOWN_GRACE_SECONDS
justflow api schema --help
usage: justflow api schema [-h] {export} ...
positional arguments:
{export}
export Copy the bundled OpenAPI document into a repository
options:
-h, --help show this help message and exit
justflow api schema export --help
usage: justflow api schema export [-h] [--output OUTPUT]
options:
-h, --help show this help message and exit
--output OUTPUT
justflow serve --help
usage: justflow serve [-h] [--config-dir CONFIG_DIR]
[--temporal-address TEMPORAL_ADDRESS]
[--task-queue TASK_QUEUE]
[--deployment-name DEPLOYMENT_NAME]
[--build-id BUILD_ID]
[--artifact-digest ARTIFACT_DIGEST]
[--package-version PACKAGE_VERSION]
[--source-revision SOURCE_REVISION]
[--runtime-profile {RuntimeProfile.LOCAL,RuntimeProfile.PRODUCTION}]
[--log-level {DEBUG,INFO,WARNING,ERROR}] [--host HOST]
[--port PORT]
[--shutdown-grace-seconds SHUTDOWN_GRACE_SECONDS]
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--temporal-address TEMPORAL_ADDRESS
--task-queue TASK_QUEUE
--deployment-name DEPLOYMENT_NAME
--build-id BUILD_ID
--artifact-digest ARTIFACT_DIGEST
--package-version PACKAGE_VERSION
--source-revision SOURCE_REVISION
--runtime-profile {RuntimeProfile.LOCAL,RuntimeProfile.PRODUCTION}
--log-level {DEBUG,INFO,WARNING,ERROR}
--host HOST
--port PORT
--shutdown-grace-seconds SHUTDOWN_GRACE_SECONDS
justflow validate --help
usage: justflow validate [-h] [--config-dir CONFIG_DIR]
[--format {human,json}]
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--format {human,json}
justflow graph --help
usage: justflow graph [-h] [--config-dir CONFIG_DIR] [-o OUTPUT]
[--mermaid-only] [--data-plane]
workflow
positional arguments:
workflow Workflow name (from configs/workflows/)
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
-o OUTPUT, --output OUTPUT
Output HTML path
--mermaid-only
--data-plane Overlay resource cylinders with uses/cache/audit edges
justflow run --help
usage: justflow run [-h] [--config-dir CONFIG_DIR] [--param KEY=VALUE]
[--request-id REQUEST_ID]
[--log-level {DEBUG,INFO,WARNING,ERROR}]
workflow
positional arguments:
workflow Workflow name to execute
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--param KEY=VALUE Trigger global (repeatable); values parse as JSON when
possible
--request-id REQUEST_ID
--log-level {DEBUG,INFO,WARNING,ERROR}
justflow definitions --help
usage: justflow definitions [-h]
{publish,export,import,migrate,migrate-scope} ...
positional arguments:
{publish,export,import,migrate,migrate-scope}
publish Publish authored workflows into the immutable catalog
export Export the configured catalog as a canonical bundle
import Validate and import a canonical catalog bundle
migrate Migrate the local catalog to the configured S3 catalog
migrate-scope Inspect or migrate retained unscoped catalog state
options:
-h, --help show this help message and exit
justflow definitions publish --help
usage: justflow definitions publish [-h] [--config-dir CONFIG_DIR]
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
justflow definitions export --help
usage: justflow definitions export [-h] [--config-dir CONFIG_DIR] --output
OUTPUT
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--output OUTPUT
justflow definitions import --help
usage: justflow definitions import [-h] [--config-dir CONFIG_DIR] --input
INPUT [--dry-run]
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--input INPUT
--dry-run
justflow definitions migrate --help
usage: justflow definitions migrate [-h] [--config-dir CONFIG_DIR] [--dry-run]
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--dry-run
justflow definitions migrate-scope --help
usage: justflow definitions migrate-scope [-h] [--config-dir CONFIG_DIR]
[--decision {migrate,keep_scoped}]
[--dry-run]
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--decision {migrate,keep_scoped}
--dry-run
justflow triggers --help
usage: justflow triggers [-h] [--config-dir CONFIG_DIR]
[--temporal-address TEMPORAL_ADDRESS]
[--task-queue TASK_QUEUE]
[--deployment-name DEPLOYMENT_NAME]
[--build-id BUILD_ID]
[--artifact-digest ARTIFACT_DIGEST]
[--package-version PACKAGE_VERSION]
[--source-revision SOURCE_REVISION]
[--runtime-profile {RuntimeProfile.LOCAL,RuntimeProfile.PRODUCTION}]
[--log-level {DEBUG,INFO,WARNING,ERROR}]
{plan,apply,list,describe,pause,resume,trigger-now,backfill,delete}
...
positional arguments:
{plan,apply,list,describe,pause,resume,trigger-now,backfill,delete}
plan Show the desired/actual schedule-trigger
reconciliation plan
apply Apply a freshly computed and explicitly confirmed
schedule-trigger plan
list List managed schedule triggers
describe Describe one managed schedule trigger
pause Pause a managed schedule trigger
resume Resume a managed schedule trigger
trigger-now Trigger-Now a managed schedule trigger
backfill Backfill a bounded schedule-trigger interval
delete Delete a managed schedule trigger with identity
confirmation
options:
-h, --help show this help message and exit
--config-dir CONFIG_DIR
--temporal-address TEMPORAL_ADDRESS
--task-queue TASK_QUEUE
--deployment-name DEPLOYMENT_NAME
--build-id BUILD_ID
--artifact-digest ARTIFACT_DIGEST
--package-version PACKAGE_VERSION
--source-revision SOURCE_REVISION
--runtime-profile {RuntimeProfile.LOCAL,RuntimeProfile.PRODUCTION}
--log-level {DEBUG,INFO,WARNING,ERROR}
justflow triggers plan --help
usage: justflow triggers plan [-h] [--unscoped {migrate,retain}]
options:
-h, --help show this help message and exit
--unscoped {migrate,retain}
Explicit decision for retained unscoped schedules
justflow triggers apply --help
usage: justflow triggers apply [-h] [--unscoped {migrate,retain}]
(--confirm PLAN_DIGEST | --non-interactive)
options:
-h, --help show this help message and exit
--unscoped {migrate,retain}
Explicit decision for retained unscoped schedules
--confirm PLAN_DIGEST
--non-interactive Apply the freshly computed plan in deployment
automation
justflow triggers list --help
usage: justflow triggers list [-h]
options:
-h, --help show this help message and exit
justflow triggers describe --help
usage: justflow triggers describe [-h] trigger
positional arguments:
trigger
options:
-h, --help show this help message and exit
justflow triggers pause --help
usage: justflow triggers pause [-h] trigger
positional arguments:
trigger
options:
-h, --help show this help message and exit
justflow triggers resume --help
usage: justflow triggers resume [-h] trigger
positional arguments:
trigger
options:
-h, --help show this help message and exit
justflow triggers trigger-now --help
usage: justflow triggers trigger-now [-h] --idempotency-key IDEMPOTENCY_KEY
trigger
positional arguments:
trigger
options:
-h, --help show this help message and exit
--idempotency-key IDEMPOTENCY_KEY
justflow triggers backfill --help
usage: justflow triggers backfill [-h] --start START --end END trigger
positional arguments:
trigger
options:
-h, --help show this help message and exit
--start START
--end END
justflow triggers delete --help
usage: justflow triggers delete [-h] --confirm DESIRED_DIGEST trigger
positional arguments:
trigger
options:
-h, --help show this help message and exit
--confirm DESIRED_DIGEST
justflow schema --help
usage: justflow schema [-h] {export} ...
positional arguments:
{export}
export Copy the bundled authoring schemas into a repository
options:
-h, --help show this help message and exit
justflow schema export --help
usage: justflow schema export [-h] [--output OUTPUT]
options:
-h, --help show this help message and exit
--output OUTPUT