Documentation / Getting Started
Run your first workflow
You need the Rippflow CLI and Python 3. No AWS account is needed for this local run.
Optional: Connect your agent! Rippflow supports Codex, Claude Code, Antigravity, and local coding agents with bundled offline docs and a portable skill (rippflow docs skill --init). Connect Your AI Agent →
1. Create the example
rippflow doctor --lang python
rippflow example finance --lang python --dir my-first-flow
cd my-first-flow2. Validate and run
rippflow validate workflow.json --handlers handlers.json
rippflow dev workflow.json --handlers handlers.json \
--input input.json --report report.jsonExpected: the terminal phase completes and report.json is created. The example uses sample finance data and one deliberate rework.
3. Make it yours
- Change
input.jsonfor new data. - Edit
handlers/finance.pyfor your logic. - Run again with a new report filename; existing reports are not overwritten.
4. Deploy to your installation
Publish through the installation's Custom::RippflowWorkflow CloudFormation resource in CI/CD, or directly with the CLI when your AWS IAM role has a scoped deploy grant:
CI/CD CloudFormation
FinanceWorkflow:
Type: Custom::RippflowWorkflow
DeletionPolicy: Retain
UpdateReplacePolicy: Retain
Properties:
ServiceToken: !Ref RippflowDeploymentServiceToken # ServiceToken output from execution-plane/deployment-service/template.json
RetainDeployment: true
Deployment:
contract: scoped-deployments-v1
installationId: production
tenantId: finance
namespace: reconciliation
definition:
name: finance-reconciliation
version: 1.0.0
phases:
ingest:
requires: []
bindings:
ingest:
type: lambda
functionArn: !Ref IngestPublishedVersionArn
invocationRoleArn: !GetAtt InvokeIngestRole.Arn
executionRoleArn: !GetAtt IngestWorkloadRole.Arn
Outputs:
WorkflowDeploymentId:
Value: !GetAtt FinanceWorkflow.DeploymentIdCLI (with deploy permission)
export RIPPFLOW_DEPLOYMENT_URL="https://REPLACE.execute-api.eu-west-1.amazonaws.com/v1"
export AWS_PROFILE=finance-deployer
rippflow deploy workflow.yaml \
--tenant finance --namespace reconciliation \
--bindings bindings.json --json
rippflow deployments inspect "$DEPLOYMENT_ID" --jsonBoth paths use the same immutable scoped-deployments-v1 contract and return a content-addressed deploymentId (requires installation >=1.9.0 and approved bindings).
Verified sources
Checked 2026-11-05.
- Local runtime guide 7f5ea32 · main
- CLI command dispatcher 7f5ea32 · main
- Generated starter and commands 7f5ea32 · main