Code Steps

<video autoPlay loop muted playsInline src="/images/workflows/add-and-configure-steps/code/create-step.mp4" />

The CLI supports the following flags and options:

| Flag | Type | Default | Description |
| --- | --- | --- | --- |
| `-s, --secret-key <key>` | string | `$NOVU_SECRET_KEY` | Novu API secret key |
| `-a, --api-url <url>` | string | config or `https://api.novu.co` | Novu API URL |
| `--config <path>` | string | `novu.config.ts` | Path to config file |
| `--out <path>` | string | from config or `./novu` | Directory containing handlers |
| `--workflow <id>` | string (repeatable) | all | Deploy only steps for specific workflow(s) |
| `--step <id>` | string (repeatable) | all | Deploy only a specific step within a workflow |
| `--template <path>` | string | — | Path to a React Email template; scaffolds a React Email email handler if the step file doesn't exist. Requires `--workflow` and `--step` (single values each). |
| `--bundle-out-dir [path]` | string or boolean | — | Write bundle artifacts to disk (debug mode, skips minification) |
| `--dry-run` | boolean | `false` | Bundle without deploying |

The CLI will perform the following:
1. Look up the step type from the Novu API.
2. Auto-scaffold a placeholder handler at `novu/<workflowId>/<stepId>.step.tsx`.
3. Bundle all handlers in the `novu/` directory.
4. Deploy to Novu.

For email steps, you can optionally link a React Email template directly:

```bash
npx novu step publish \
  --workflow your-workflow-id \
  --step your-step-id \
  --template ./emails/welcome.tsx \
  --secret-key nv-sk-...
```

If you dont want to pass secret key to CLI, it will try to read NOVU_SECRET_KEY variable from `.env` file if present.

Also similarly for `apiUrl`, by default it uses US, but you can specify EU or other regions either in novu.config.ts or directly in CLI command.

Open the generated file and replace the placeholder content with your real logic. Each handler receives the full context:

```typescript title="novu/workflow-id/step-id.step.tsx"
export default step.inApp(
  "in-app-step",
  async (controls, { payload, subscriber }) => ({
    subject: controls.subject,
    body: `Hi ${subscriber.firstName}, ${controls.body} `,
  }),
  {
    controlSchema: {
      type: "object",
      properties: {
        subject: { type: "string", default: "New activity" },
        body: { type: "string", default: "You have a new notification." },
      },
      additionalProperties: false,
    } as const,
  }
);
```

If the bundle content changed, Novu deploys a new version. This `publish` command by default will publish all step handler in novu folder, if you want to publish just one workflow or one step you can specify `--workflow` and `--step` flags

import { step } from '@novu/framework/step-resolver';
import { z } from 'zod';

export default step.sms(
  'send-sms',
  async (controls, { subscriber }) => ({
    body: `${controls.greeting} ${subscriber.firstName ?? 'there'}, ${controls.message}`,
  }),
  {
    controlSchema: z.object({
      greeting: z.string().default('Hello'),
      message: z.string().default('You have a new notification.'),
    }),
  }
);

export default step.sms(
  'send-sms',
  async (controls, { payload }) => ({
    body: `You have a new message: ${payload.text}`,
  }),
  {
    skip: (controls, { payload }) => payload.optedOutOfSms === true,
  }
);

import { step } from '@novu/framework/step-resolver';

export default step.email(
  'welcome-email',
  async (controls, { payload }) => ({
    subject: 'Welcome!',
    body: `<p>Hello ${payload.name}</p>`,
  }),
  {
    providers: {
      sendgrid: ({ outputs }, ctx) => ({
        _passthrough: {
          body: {
            categories: ['onboarding'],
            asm: { group_id: 12345 },
          },
        },
      }),
    },
  }
);

export default step.email(
  'raw-html-email',
  async (controls, { payload }) => ({
    subject: 'Your report',
    body: payload.htmlContent,
  }),
  {
    disableOutputSanitization: true,
  }
);

// novu.config.ts
const config = {
  outDir: './novu',
  apiUrl: 'https://api.novu.co',
  aliases: {
    '@emails': './src/emails',
  },
};

export default config;

npm install --save-dev @novu/framework