# Caelus

> Define a command once. Dispatch it from anywhere.

## Table of Contents

### @ufo-soft/caelus

- [core](/api/@ufo-soft/caelus/core.md)
- [keybindings](/api/@ufo-soft/caelus/keybindings.md)

#### core

##### Classes

- [Class: Registry](/api/@ufo-soft/caelus/core/classes/Registry.md)

##### Interfaces

- [Interface: Command](/api/@ufo-soft/caelus/core/interfaces/Command.md)
- [Interface: Parameter](/api/@ufo-soft/caelus/core/interfaces/Parameter.md)
- [Interface: Registration](/api/@ufo-soft/caelus/core/interfaces/Registration.md)

##### Type Aliases

- [Type Alias: Args](/api/@ufo-soft/caelus/core/type-aliases/Args.md)
- [Type Alias: Commands](/api/@ufo-soft/caelus/core/type-aliases/Commands.md)
- [Type Alias: Handler](/api/@ufo-soft/caelus/core/type-aliases/Handler.md)
- [Type Alias: Handlers\<C>](/api/@ufo-soft/caelus/core/type-aliases/Handlers.md)
- [Type Alias: Outcome\<T>](/api/@ufo-soft/caelus/core/type-aliases/Outcome.md)
- [Type Alias: ParameterType](/api/@ufo-soft/caelus/core/type-aliases/ParameterType.md)
- [Type Alias: Send](/api/@ufo-soft/caelus/core/type-aliases/Send.md)

##### Variables

- [Variable: FAILED](/api/@ufo-soft/caelus/core/variables/FAILED.md)
- [Variable: OK](/api/@ufo-soft/caelus/core/variables/OK.md)

##### Functions

- [Function: bind()](/api/@ufo-soft/caelus/core/functions/bind.md)
- [Function: failed()](/api/@ufo-soft/caelus/core/functions/failed.md)
- [Function: forward()](/api/@ufo-soft/caelus/core/functions/forward.md)
- [Function: ok()](/api/@ufo-soft/caelus/core/functions/ok.md)
- [Function: render()](/api/@ufo-soft/caelus/core/functions/render.md)

#### keybindings

##### Interfaces

- [Interface: Keybindings](/api/@ufo-soft/caelus/keybindings/interfaces/Keybindings.md)

##### Type Aliases

- [Type Alias: Keymap](/api/@ufo-soft/caelus/keybindings/type-aliases/Keymap.md)
- [Type Alias: KeyTarget](/api/@ufo-soft/caelus/keybindings/type-aliases/KeyTarget.md)
- [Type Alias: Source](/api/@ufo-soft/caelus/keybindings/type-aliases/Source.md)
- [Type Alias: Table](/api/@ufo-soft/caelus/keybindings/type-aliases/Table.md)

##### Variables

- [Variable: UNBIND](/api/@ufo-soft/caelus/keybindings/variables/UNBIND.md)

##### Functions

- [Function: attach()](/api/@ufo-soft/caelus/keybindings/functions/attach.md)
- [Function: canonical()](/api/@ufo-soft/caelus/keybindings/functions/canonical.md)
- [Function: chordOf()](/api/@ufo-soft/caelus/keybindings/functions/chordOf.md)
- [Function: keybindings()](/api/@ufo-soft/caelus/keybindings/functions/keybindings.md)
- [Function: parseKeymap()](/api/@ufo-soft/caelus/keybindings/functions/parseKeymap.md)
- [Function: resolve()](/api/@ufo-soft/caelus/keybindings/functions/resolve.md)

### @ufo-soft/caelus-cli

#### Interfaces

- [Interface: Io](/api/@ufo-soft/caelus-cli/interfaces/Io.md)

#### Type Aliases

- [Type Alias: OptionValues](/api/@ufo-soft/caelus-cli/type-aliases/OptionValues.md)

#### Functions

- [Function: argsOf()](/api/@ufo-soft/caelus-cli/functions/argsOf.md)
- [Function: cli()](/api/@ufo-soft/caelus-cli/functions/cli.md)
- [Function: optionOf()](/api/@ufo-soft/caelus-cli/functions/optionOf.md)

### @ufo-soft/caelus-mcp

#### Functions

- [Function: mcp()](/api/@ufo-soft/caelus-mcp/functions/mcp.md)
- [Function: resultOf()](/api/@ufo-soft/caelus-mcp/functions/resultOf.md)
- [Function: shapeOf()](/api/@ufo-soft/caelus-mcp/functions/shapeOf.md)
- [Function: stdio()](/api/@ufo-soft/caelus-mcp/functions/stdio.md)

### Guide

- [Quickstart](/guide/quickstart.md)
- [Commands](/guide/commands.md)

### Surfaces

- [Keybindings](/guide/keybindings.md)
- [CLI](/guide/cli.md)
- [MCP](/guide/mcp.md)
- [Forwarding](/guide/forwarding.md)

### Architecture

- [Architecture](/architecture.md)
- [Examples](/architecture/examples.md)
- [Known limits](/architecture/limits.md)

### Other

- [API reference](/api.md)
- [Caelus](/index.md)