CLI Reference

The intu CLI is the primary interface for creating, running, and managing Intuware projects. Every command supports the global flags listed at the bottom of this page.

Commands

intu init <project-name>

Scaffold a new Intuware project with the standard directory structure, starter configuration, and dependencies.

Flag	Description	Default
--dir <path>	Target directory for the new project	./<project-name>

The command generates intu.yaml, tsconfig.json, a sample channel, and runs npm install automatically.

intu init my-engine
intu init my-engine --dir /opt/integrations/my-engine

Tip

Pass --dir when you need the project folder created somewhere other than your current working directory.

intu c <channel-name>

Alias: intu channel <channel-name>

Create a new channel directory under channels/ containing the three starter files:

File	Purpose
channel.yaml	Channel configuration (listeners, destinations, pipeline)
transformer.ts	TypeScript transformer function
validator.ts	TypeScript validation function

intu c adt-feed
intu channel patient-sync

intu serve

Start the Intuware engine. TypeScript files are compiled automatically on startup, and hot-reload watches for file changes so the engine restarts when you edit channel config or code.

intu serve
intu serve --profile dev
intu serve --verbose

Note

intu serve is the underlying command behind all three npm scripts (dev, serve, start). See npm scripts below.

intu validate

Validate every channel.yaml and intu.yaml file in the project against their JSON schemas. Exits with a non-zero code if any file is invalid.

intu validate

Caution

Always run intu validate in CI before deploying. Schema violations that slip into production will prevent channels from starting.

intu build

Compile all TypeScript files in the project without starting the engine. Useful in Docker builds and CI pipelines where you need a compile step separated from runtime.

intu build

intu import mirth <file.xml>

Import a Mirth Connect channel export XML and generate the equivalent Intuware channel directory with channel.yaml and transformer.ts.

intu import mirth exported-channels.xml

Tip

After importing, review the generated transformer.ts — complex Mirth JavaScript transformers may need manual adjustment.

intu message list

List stored messages with optional filters.

Flag	Description	Default
--channel <id>	Filter by channel ID	all channels
--status <status>	Filter by message status (received, transformed, sent, error)	all statuses
--limit <n>	Maximum number of messages to return	50

intu message list
intu message list --channel adt-feed --status error --limit 20

intu message get <id>

Retrieve a single stored message by ID, including the raw payload at every pipeline stage.

intu message get msg_01HQXK9V7W

intu message reprocess <id>

Re-inject a stored message back into its channel pipeline from the beginning.

intu message reprocess msg_01HQXK9V7W

Caution

Reprocessing sends the message through the full pipeline again, including any destinations. Make sure downstream systems can handle duplicate delivery or are idempotent.

intu version

Print the installed CLI version and exit.

intu version

Global Flags

These flags are accepted by every command:

Flag	Description	Default
--profile <name>	Activate a configuration profile (dev, prod, or a custom name)	none
--config <path>	Path to the root intu.yaml file	./intu.yaml
--verbose	Enable verbose logging output	false
--quiet	Suppress all non-error output	false

intu serve --profile prod --config /etc/intu/intu.yaml --verbose

npm Scripts

Every project scaffolded with intu init includes these npm scripts in package.json:

Script	Command	Description
npm run dev	intu serve --profile dev	Start with the dev profile
npm run serve	intu serve	Start with the default profile
npm start	intu serve	Start with the default profile
npm run build	intu build	Compile TypeScript only

Quick Reference

Command	Description
intu init <name>	Scaffold a new project
intu c <name>	Create a channel
intu serve	Start the engine (hot-reload)
intu validate	Validate YAML config files
intu build	Compile TypeScript
intu import mirth <xml>	Import Mirth Connect channel
intu message list	List stored messages
intu message get <id>	Get a message
intu message reprocess <id>	Reprocess a message
intu version	Print version