Local Development

Authenticate

Log in before creating or deploying a Cloud project:

swirls auth login

Create or select a project

Create a new Cloud project:

swirls project create

List existing projects:

swirls project list

Configure the project

Generate swirls.config.ts in your working directory:

swirls configure

The command prompts for your project ID and writes the config file:

import { defineConfig } from '@swirls/sdk/config'

export default defineConfig({
  projectId: '<your-project-id>',
  genPath: 'src/swirls.gen.ts',
})

The CLI reads swirls.config.ts to determine which project all commands apply to. swirls config is an alias for swirls configure.

Write .swirls files

Write your workflow definitions in .swirls files. See the Swirls Language reference for syntax and available node types. Use swirls doctor to validate your files:

swirls doctor

Generate TypeScript types

Generate TypeScript types from your project's form definitions:

swirls form generate

The CLI writes generated code to the path configured in genPath. Import these types in your application for end-to-end type safety around form payloads and project integrations.

Deploy for inspection

Deploy the project to Swirls Cloud:

swirls deploy

After deploy, open the Portal to visually inspect the compiled project and verify the workflows, triggers, forms, and schemas Swirls parsed from your files. Free deploys do not include workflow execution or agent chat.