This is the meta-package that ships the skelm CLI bin and re-exports the runtime. It depends on:

• @skelm/core — runtime, types, builders, permissions, event bus
• @skelm/cli — command-line interface and programmatic primitives
• @skelm/scheduler and @skelm/integration-sdk — trigger helpers and integration authoring primitives

The CLI package brings the gateway runtime it needs for local execution. Install @skelm/gateway directly only when you are embedding or extending the gateway package itself.

Install

npm install -g skelm
skelm init my-bot && cd my-bot
skelm run workflows/hello.workflow.mts

For project-local use:

npm install skelm zod

Quickstart

// my.workflow.mts
import { code, pipeline } from 'skelm'
import { z } from 'zod'

export default pipeline({
  id: 'hello',
  input:  z.object({ name: z.string() }),
  output: z.object({ greeting: z.string() }),
  steps: [
    code({
      id: 'greet',
      run: (ctx) => ({ greeting: `hello, ${ctx.input.name}` }),
    }),
  ],
})

skelm run my.workflow.mts --input '{"name":"world"}'
# → {"greeting":"hello, world"}

Usage

skelm init                            # Scaffold a project
skelm builder                         # Author workflows from a terminal chat UI
skelm run workflow.mts                # Run a workflow once
skelm run workflow.mts --events json  # Stream JSON events to stderr
skelm schedule add workflow.mts --cron '0 9 * * 1-5'  # Schedule on a cron
skelm schedule list                   # List schedules
skelm history --last 20               # Recent runs
skelm gateway start --foreground      # Start the gateway in this process
skelm gateway status                  # Inspect a running gateway
skelm gateway stop                    # Stop it
skelm gateway install --systemd       # Install as a systemd user service

What is exported

Everything from @skelm/core:

• Builders — pipeline(), persistentWorkflow(), code(), infer(), agent(), parallel(), forEach(), branch(), loop(), wait(), pipelineStep()
• Runtime — runPipeline(), Runner, RunOptions
• Types — Pipeline, Step, Context, Run, StepResult, RunMetadata, RunStatus, StepStatus, RetryPolicy, ...
• Schemas — SkelmSchema, SchemaValidationError (Standard Schema-compatible; Zod is the documented default)
• Events — EventBus, RunEvent, RunEventType
• Permissions — AgentPermissions, TrustEnforcer, resolvePermissions
• Errors — StepError, RunCancelledError, WaitTimeoutError, serializeError

Learn more

Full documentation, examples, and source code:

github.com/scottgl9/skelm

Stability

0.x — APIs may change between minor versions until v1.

License

MIT