Skip to main content

English | 简体中文 | 繁體中文 | 日本語 | Русский

ErisPulse-TerminalAdapter

ErisPulse-TerminalAdapter

ErisPulse Terminal adapter — the terminal is the chat, zero-config

PyPI Python License ErisPulse


English

Features

  • Zero config — no platform account or token needed, install and run
  • One line, one message — every line typed in the terminal becomes a private message that triggers command / module handlers
  • Replies printed to stdout — the bot's SendDSL replies are printed with a [Bot] prefix
  • Standard actions work — get_user_info / get_self_info / get_friend_list return mock data so framework standard actions keep working
  • Readable rendering — non-text segments (image / voice / file / mention ...) render as readable placeholders
  • i18n aware — welcome / goodbye / hint messages follow the framework's i18n language

Install

pip install ErisPulse-TerminalAdapter

Requires ErisPulse >= 2.7.0.

Configuration

config.toml:

[TerminalAdapter]
bot_id = "terminal_bot"
bot_name = "TerminalBot"
user_id = "terminal_user"
user_name = "User"
prompt = "> "
reply_prefix = "[Bot] "
echo_input = false
Field Default Description
bot_id terminal_bot Bot user ID
bot_name TerminalBot Bot nickname
user_id terminal_user Mocked user ID (the terminal user chatting with the bot)
user_name User Mocked user nickname
prompt > Input prompt
reply_prefix [Bot] Prefix prepended to each bot reply line (empty for none)
echo_input false Echo user input (useful for piped input)

The adapter registers under platform name terminal and exposes a single private-chat session (no groups).

Usage

After epsdk run, the terminal becomes the chat:

> Terminal adapter started. Type a message to chat with the Bot. Ctrl+C / EOF to quit.
> Use /help to list commands.

> /hello
[Bot] Hello, User!
> ping
[Bot] ...

You can also pipe input in, which is handy for automated testing:

echo "/hello" | epsdk run main.py

Non-text segments render as placeholders ([image: url], [voice: url], @user_id, ...). Group-related actions are unsupported (no groups in a terminal).

Notes

  • stdin is read in a worker thread, so on shutdown the reader only returns after the next line or EOF (Ctrl+D / Ctrl+Z).
  • Welcome / goodbye / hint messages follow the framework's i18n language setting.

简体中文

特性

  • 零配置即用 —— 不需要注册任何平台账号、不需要 token,装上就能跑
  • 一行一消息 —— 终端里每输入一行即一条私聊消息,直接触发命令 / 模块处理器
  • 回复即打印 —— Bot 通过 SendDSL 回复的内容带 [Bot] 前缀打印到 stdout
  • 标准动作可用 —— get_user_info / get_self_info / get_friend_list 等返回模拟数据,框架标准动作照常工作
  • 多段渲染 —— 非文本消息段(图片 / 语音 / 文件 / @ 等)渲染成可读占位符
  • i18n 跟随 —— 欢迎语 / 退出语跟随框架 i18n 语言设置

安装

pip install ErisPulse-TerminalAdapter

需要 ErisPulse >= 2.7.0。

配置

config.toml:

[TerminalAdapter]
bot_id = "terminal_bot"
bot_name = "TerminalBot"
user_id = "terminal_user"
user_name = "User"
prompt = "> "
reply_prefix = "[Bot] "
echo_input = false
字段 默认值 说明
bot_id terminal_bot Bot 的用户 ID
bot_name TerminalBot Bot 昵称
user_id terminal_user 模拟用户的 ID(与 Bot 对话的终端用户)
user_name User 模拟用户昵称
prompt > 输入提示符
reply_prefix [Bot] Bot 回复的行前缀(留空则不加前缀)
echo_input false 是否回显用户输入(管道输入场景下开启)

适配器注册的平台名为 terminal,只有一个私聊会话,没有群组概念。

使用

epsdk run 启动后,终端就是聊天窗口:

> 终端适配器已启动。直接输入消息即可与 Bot 对话,Ctrl+C 或 EOF 退出。
> 输入 /help 查看可用命令。

> /hello
[Bot] Hello, User!
> ping
[Bot] ...

也可以通过管道喂入,便于自动化测试:

echo "/hello" | epsdk run main.py

非文本消息段会渲染成占位符([image: url]、[voice: url]、@user_id 等)。群组相关操作不支持(终端无群组)。

说明

  • stdin 在独立线程中读取,关闭时需等到下一行或 EOF(Ctrl+D / Ctrl+Z)才会退出。
  • 欢迎语 / 退出语 / 提示语跟随框架 i18n 语言设置。

Related · ErisPulse · Documentation · Issues

Metadata

Release files for ErisPulse-TerminalAdapter 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ErisPulse-TerminalAdapter 1.2.1
File Size Uploaded Provenance Actions
erispulse_terminaladapter-1.2.1.tar.gz 529.2 kB With provenance Details for erispulse_terminaladapter-1.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ErisPulse-TerminalAdapter 1.2.1
File Interpreter ABI Platform Actions
erispulse_terminaladapter-1.2.1-py3-none-any.whl Python 3 none any Details for erispulse_terminaladapter-1.2.1-py3-none-any.whl

Total release size: 539.8 kB

Release files / erispulse_terminaladapter-1.2.1.tar.gz

Download URL erispulse_terminaladapter-1.2.1.tar.gz
Size 529.2 kB
Tags Source
SHA-256 checksum
How to use checksums
fdb64bb45338f32b84edb5d24dc90bc60f2182f0daa661349eefdb4c22a4ed0a
BLAKE2b-256 checksum
How to use checksums
65afc5fc3f93dca598cf76115eec32e5c1011170b8ae6f0707ea7db1f5fc3ce0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

Release files / erispulse_terminaladapter-1.2.1-py3-none-any.whl

Download URL erispulse_terminaladapter-1.2.1-py3-none-any.whl
Size 10.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
27cb9cc35da21490a6bb63da47d8206e02a2c3c5480acf2b8c93da64ec6d069b
BLAKE2b-256 checksum
How to use checksums
f6720234ac3172a47eb87074c6510bffe8f1dac0a250047ca0109ca60eb9c16d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

Security for ErisPulse-TerminalAdapter 1.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for erispulse_terminaladapter-1.2.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page