Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.agentfront.dev/llms.txt

Use this file to discover all available pages before exploring further.

Generates a @Flow class with all lifecycle stage methods: pre, execute, post, finalize, and error.

​
Usage

nx g @frontmcp/nx:flow audit-log --project crm

​
Options

OptionTypeDefaultDescription
namestring—Required. The name of the flow
projectstring—Required. The project to add the flow to
directorystring—Subdirectory within src/flows/

​
Generated Code

import { Flow, FlowBase } from '@frontmcp/sdk';

@Flow({
  name: 'audit-log',
  description: 'TODO: describe what this flow does',
  plan: {
    steps: ['pre', 'execute', 'post', 'finalize'],
  },
})
export default class AuditLogFlow extends FlowBase {
  async pre(): Promise<void> {
    // TODO: pre-processing logic
  }

  async execute(): Promise<void> {
    // TODO: main execution logic
  }

  async post(): Promise<void> {
    // TODO: post-processing logic
  }

  async finalize(): Promise<void> {
    // TODO: finalization logic
  }

  async error(err: Error): Promise<void> {
    // TODO: error handling logic
    throw err;
  }
}
See the Flows guide for lifecycle details and hook integration.