Skip to main content

vai workflow create

Scaffold a publish-ready npm package from an existing workflow JSON file or from scratch.

Synopsis​

vai workflow create [options]

Description​

vai workflow create generates a complete npm package structure for sharing a workflow with the community. It creates the package.json (with the vai field populated), copies or scaffolds the workflow.json, generates a README template, and adds a LICENSE file.

The generated package can be published to npm with npm publish.

Options​

FlagDescriptionDefault
--from <file>Existing workflow JSON to package(none)
--name <name>Package name (without vai-workflow- prefix)derived from workflow
--author <name>Author namefrom git config
--output <dir>Output directory./vai-workflow-<name>/

Examples​

Package an existing workflow​

vai workflow create --from ./legal-research.json --name legal-research

Output:

Creating workflow package: vai-workflow-legal-research

✔ Validated workflow definition
✔ Created vai-workflow-legal-research/
  ├── package.json
  ├── workflow.json
  ├── README.md
  └── LICENSE

Next steps:
  1. Edit README.md with usage instructions
  2. cd vai-workflow-legal-research
  3. npm publish

Interactive mode (no --from)​

vai workflow create

Prompts for a name, description, category, and author, then generates a template directory with an empty workflow you can fill in.

Custom output directory​

vai workflow create --from ./my-workflow.json --output ./packages/my-workflow

Generated Package Structure​

vai-workflow-<name>/
├── package.json          # npm metadata with vai field
├── workflow.json         # Workflow definition
├── README.md             # Usage instructions template
└── LICENSE               # MIT license

The scaffolder automatically:

  • Extracts tools from workflow steps for the vai.tools field
  • Copies input definitions for the vai.inputs field
  • Infers a category from the tools used
  • Generates a README template with input documentation