Actoviq Agent SDK

English | Chinese

Documentation site: https://deconbear.github.io/actoviq-agent-sdk/

Actoviq Agent SDK is an experimental TypeScript SDK for building multi-tool, multi-session agents with a clean-first public API, MCP integration, and memory helpers.

This project is inspired by excellent agent projects and runtimes including Claude Code, Codex, Deepagents, and similar work in the ecosystem. Actoviq remains an independent project with its own public SDK surface and documentation.

This repository is still under active development. APIs and runtime behavior may continue to evolve. Issues and pull requests are very welcome.

Install

npm install actoviq-agent-sdk zod

For local examples, place your config at:

~/.actoviq/settings.json

You can also preload a custom JSON file with loadJsonConfigFile(...).

Quick Start

import { createAgentSdk, loadDefaultActoviqSettings } from 'actoviq-agent-sdk';

await loadDefaultActoviqSettings();

// Default: Anthropic protocol
const sdk = await createAgentSdk();

// Or use OpenAI / OpenAI-compatible APIs (DeepSeek, vLLM, etc.)
const sdk = await createAgentSdk({
  provider: 'openai',
  baseURL: 'https://api.deepseek.com',
  model: 'deepseek-chat',
});

try {
  const result = await sdk.run('Introduce yourself in one short sentence.');
  console.log(result.text);
} finally {
  await sdk.close();
}

Run the repository examples with:

npm run example:actoviq-quickstart
npm run example:actoviq-agent-helpers

CLI REPL

After installing the package, you can start an interactive scrollback-mode REPL directly from the terminal:

npx actoviq-react [work-dir]

This launches a readline-based interactive agent with:

• Real-time streaming output in the main terminal buffer (native scrollback)
• Tab completion for slash commands (/help, /clear, /compact, /memory, /model, /tools, /dream, /exit)
• Command history via ↑↓ arrow keys
• Ctrl+C to abort the current request, press twice to exit

Note: actoviq-react is a lightweight scrollback REPL, not a full-featured TUI. It does not use an alternate screen buffer, ScrollBox, or rich terminal rendering. It is designed for quick interaction and debugging, not as a replacement for a complete terminal UI.

Tutorials

• English tutorial: docs/en/README.md
• Chinese tutorial: docs/zh/README.md
• GitHub Pages docs site:
  • https://deconbear.github.io/actoviq-agent-sdk/

Start with these examples:

• examples/actoviq-quickstart.ts
• examples/actoviq-workflow.ts
• examples/actoviq-agent-helpers.ts

Contributing

Contributions are welcome. If you spot a bug or a documentation gap, please open an issue or submit a pull request.

Licensed under the MIT License.