Grace LogoGrace

CLI Reference

Explore the commands and options available in the Grace Command Line Interface.

The Grace Command Line Interface (CLI) is your primary tool for interacting with Grace workflows. It allows you to initialize new projects, validate configurations, prepare mainframe artifacts, and execute your orchestration pipelines.

Each command is designed to be intuitive and provide clear feedback. Use the -h or --help flag with any command or subcommand for specific assistance.

Core

Manage your Grace workflows from initialization to execution.

grace init

Scaffold a new Grace workflow, including starter files and directory structure.

grace lint

Validate the syntax and structural integrity of your grace.yml workflow definition.

grace deck

Generate JCL, prepare local artifacts, and upload necessary files to your z/OS system.

grace run

Execute a defined workflow synchronously, with real-time monitoring and terminal output.

grace submit

Submit a workflow for asynchronous execution in a detached background process.

Utility

Additional commands for managing and observing your Grace environment.

grace logs (TBD)

Tail the logs of a running workflow.

grace summary (TBD)

Display or process workflow execution summaries.

grace status (TBD)

Check the status of asynchronously submitted workflows.

grace version (TBD)

Display the installed Grace CLI version (if not just grace --version).

VSAM → PostgreSQL

Orchestrate a full ETL pipeline, inserting z/OS VSAM KSDS records into an AWS RDS Postgres instance using Grace.

grace init

Scaffold a new Grace workflow.

On this page