skelm
v0.4.3
Published
skelm — TypeScript framework for secure, agentic, long-running workflows
Maintainers
Readme
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
For the long-running orchestrator (HTTP, registries, audit, agent lifecycle), install @skelm/gateway separately so this meta package stays small for users who only need the authoring + runner surface.
Install
npm install -g skelm
skelm init my-bot && cd my-bot
skelm run workflows/hello.workflow.mtsFor project-local use:
npm install skelm zodQuickstart
// 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 run workflow.ts # Run a workflow once
skelm run workflow.ts --events json # Stream JSON events to stderr
skelm schedule add workflow.ts --cron '0 9 * * 1-5' # Schedule on a cron
skelm schedule list # List schedules
skelm history --last 20 # Recent runs
skelm gateway start # Start the long-running orchestrator (foreground)
skelm gateway status # Inspect a running gateway
skelm gateway stop # Stop it
skelm gateway install --systemd # Install as a systemd user serviceWhat is exported
Everything from @skelm/core:
- Builders —
pipeline(),code(),llm(),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:
Stability
0.x — APIs may change between minor versions until v1.
