CLI Reference
Complete reference for all intu CLI commands
Installation
npm install -g intu-dev
Or build from source:
go build -o intu .
Global Flags
| Flag | Values | Default | Description |
|---|---|---|---|
--log-level |
debug | info | warn | error |
info |
Set the logging verbosity |
Commands
intu init <project-name>
Bootstrap a new intu project with all scaffolding, including YAML configuration files, TypeScript boilerplate, and a sample channel.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Parent directory in which the project folder is created |
--force |
false |
Overwrite existing files if the directory already exists |
intu init my-project --dir /tmp
intu c <channel-name>
Quick alias to add a new channel to the current project. Creates the channel directory, channel.yaml, transformer.ts, and validator.ts.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--force |
false |
Overwrite existing channel files |
intu c adt-inbound --dir .
intu channel add <channel-name>
Add a new channel to the project. Functionally identical to intu c.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--force |
false |
Overwrite existing channel files |
intu channel add lab-results --dir .
intu channel list
List all configured channels in the project. Supports filtering by profile, tag, and group.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
— | Load a specific profile overlay |
--tag |
— | Filter channels by tag |
--group |
— | Filter channels by group |
intu channel list --dir . --profile prod
intu channel describe <channel-id>
Show detailed configuration for a specific channel, including its source, transformers, validators, and destinations.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
— | Load a specific profile overlay |
intu channel describe sample-channel --dir .
intu validate
Validate all YAML configuration and TypeScript files in the project. Returns a non-zero exit code if errors are found.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
— | Load a specific profile overlay |
intu validate --dir .
intu build
Compile TypeScript transformers and validators. Runs npm run build (which invokes tsc) inside the project directory.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
intu build --dir .
intu serve
Start the runtime engine to process messages through configured channels. Loads configuration, boots all enabled channels (respecting dependency order), initializes message storage, alerting, and metrics, then processes messages until interrupted.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
— | Load a specific profile overlay |
intu stats [channel-id]
Show channel statistics. When a channel ID is provided, displays stats for that specific channel; otherwise shows aggregate stats for all channels.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
— | Load a specific profile overlay |
--json |
false |
Output statistics in JSON format |
intu deploy [channel-id]
Mark channels as enabled and deployed. Without a channel ID, use --all or --tag to target multiple channels.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
— | Load a specific profile overlay |
--all |
false |
Deploy all channels |
--tag |
— | Deploy channels matching a tag |
intu undeploy <channel-id>
Remove a channel from deployed state.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
— | Load a specific profile overlay |
intu enable <channel-id>
Enable a channel so it processes messages at runtime.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
— | Load a specific profile overlay |
intu disable <channel-id>
Disable a channel to stop it from processing messages.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
— | Load a specific profile overlay |
intu prune
Prune old message data from storage. Supports filtering by channel, date, and dry-run mode for previewing what would be removed.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--channel |
— | Prune data for a specific channel |
--all |
false |
Prune data for all channels |
--before |
— | Prune messages older than this date (ISO 8601) |
--dry-run |
false |
Preview what would be pruned without deleting |
--confirm |
false |
Skip confirmation prompt |
intu dashboard
Launch the web-based dashboard for monitoring channels, viewing statistics, and managing configuration.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
— | Load a specific profile overlay |
--port |
3000 |
Port for the dashboard web server |
intu channel clone <source> <new-name>
Clone an existing channel to create a new one. Copies all files from the source channel directory and updates the channel ID in channel.yaml.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--profile |
dev |
Config profile |
intu channel clone sample-channel hl7-inbound --dir .
intu channel export <channel-id>
Export a channel as a portable .tar.gz archive for sharing or backup.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
-o, --output |
<channel-id>.tar.gz |
Output file path |
intu channel export adt-inbound --dir . -o adt-inbound.tar.gz
intu channel import <archive-path>
Import a channel from a .tar.gz archive into the channels directory.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--force |
false |
Overwrite existing files |
intu channel import adt-inbound.tar.gz --dir .
intu message list
List messages from the message store. Supports filtering by channel, status, and time range.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--channel |
— | Filter by channel ID |
--status |
— | Filter by status (RECEIVED, TRANSFORMED, SENT, ERROR, FILTERED) |
--since |
— | Messages since date (RFC3339 or YYYY-MM-DD) |
--before |
— | Messages before date (RFC3339 or YYYY-MM-DD) |
--limit |
50 |
Maximum number of results |
--json |
false |
Output in JSON format |
intu message list --channel adt-inbound --status ERROR --limit 20
intu message get <message-id>
Retrieve a specific message by its ID, including full content and metadata.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--json |
false |
Output in JSON format |
intu message count
Count messages in the store, optionally filtered by channel and status.
| Flag | Default | Description |
|---|---|---|
--dir |
. |
Project directory |
--channel |
— | Filter by channel ID |
--status |
— | Filter by status |