@sublang/cligent

cligent

Unified TypeScript SDK for AI coding agent CLIs (Claude Code, Codex CLI, Gemini CLI, OpenCode, and more).

Register an adapter, send a prompt, and consume a single async event stream — regardless of which agent runs underneath.

Install

npm install @sublang/cligent

Quick start

import { Cligent } from '@sublang/cligent';
import { ClaudeCodeAdapter } from '@sublang/cligent/adapters/claude-code';

// Cligent wraps an adapter with role identity, session continuity,
// option merging, and protocol hardening.
const agent = new Cligent(new ClaudeCodeAdapter(), {
  role: 'coder',
  model: 'claude-opus-4-8',
});

for await (const event of agent.run('Refactor auth module')) {
  if (event.type === 'text_delta') process.stdout.write(event.payload.delta);
  if (event.type === 'done') console.log('\nDone:', event.payload.status);
}

// Session continuity — the next run auto-resumes the previous session.
for await (const event of agent.run('Now add tests for it')) {
  // ...
}

Supported agents

• Claude Code — via @anthropic-ai/claude-agent-sdk
• Codex CLI — via @openai/codex-sdk
• Gemini CLI — via child-process NDJSON
• OpenCode — via @opencode-ai/sdk

tmux-play

tmux-play is a reference application built on Cligent — a working showcase of what you can compose with the SDK. You chat with a Captain on the left pane; the Captain dispatches work to players, each a Cligent on its own adapter and model, streaming live into its own pane on the right.

npm install -g @sublang/cligent
tmux-play                                # discover or create config
tmux-play --config ./tmux-play.config.yaml

On first run, if neither the cwd nor the home config exists, tmux-play creates ${XDG_CONFIG_HOME:-~/.config}/tmux-play/config.yaml and starts with the built-in fanout Captain plus a claude and a codex player.

Requirements:

• tmux.
• glow — Markdown renderer used by the in-pane output pipeline; the launcher fails fast if it is missing.
• Credentials and any out-of-process CLIs for the adapters you use: Claude Code, Codex CLI, Gemini CLI, OpenCode.

The Captain is the extension point. tmux-play owns player orchestration, panes, and event streaming; you write a Captain to decide how players collaborate — fanout, planner/router, debate protocol, an XState graph, anything. The built-in fanout Captain runs every player in parallel and synthesizes their answers; swap it for your own using the same contract.

See docs/tmux-play.md for config, layout, notifications, and writing a Captain.

Documentation

• docs/guide.md — Cligent class, adapters, permissions, session continuity, parallel execution, event types.
• docs/tmux-play.md — tmux-play config, layout, notifications, snapshot, and writing custom Captains.

Contributing

We welcome contributions of all kinds. If you'd like to help:

• Star our repo if you find cligent useful.
• Open an issue for bugs or feature requests.
• Open a PR for fixes or improvements.
• Discuss on Discord for support or new ideas.

License

Apache-2.0