Loading AgentsKit ecosystem navigation…
AgentsKit Chat

CLI

Full agentskit-chat CLI — init, add component, shell completion.

View canonical Markdown

CLI

code
pnpm add -g @agentskit/chat-cli
# or
pnpm dlx @agentskit/chat-cli@0.4.0 <command>

Commands

CommandPurpose
agentskit-chat init [dir]Scaffold a complete chat project
agentskit-chat add component <name>Generate a schema-backed component
agentskit-chat completion <shell>Print bash / zsh / fish completion
--help / --versionHelp and version

Command map

Loading diagram...

init

code
agentskit-chat init [directory] --renderer <name> [--yes]
FlagDescription
[directory]Target path — must not exist
--rendererreact · vue · svelte · solid · angular · react-native · ink
--yesNon-interactive (CI)

Without --renderer, detects host stack when unambiguous; TTY may prompt once.

Creates: src/chat.ts, Web-standard src/server.ts, native entry, TS config, test, README. Never overwrites.

code
agentskit-chat init my-chat --renderer react --yes
agentskit-chat init my-mobile --renderer react-native --yes
agentskit-chat init my-cli --renderer ink --yes
pnpm dlx @agentskit/chat-cli@0.4.0 init my-chat --renderer react --yes

add component

code
agentskit-chat add component <name> --renderer react,vue[,ink...] [--directory .] [--yes]

Writes src/components/<name>.ts (schema + fallback) + presentation files per renderer. Checks destinations, rejects symlink traps, rolls back on failure.

code
agentskit-chat add component status-card --renderer react,vue,ink --directory . --yes

Register the export in your component manifest — Components.

completion

code
agentskit-chat completion bash
agentskit-chat completion zsh
agentskit-chat completion fish

Errors

CodeFix
RENDERER_REQUIREDPass a supported --renderer
TARGET_EXISTSNew directory name
MANIFEST_INVALIDFix host package.json or pass flags
COMPONENT_INVALIDRename component
COMPONENT_EXISTSRename or remove collision