Skip to content

yachiyo channel

Inspects the users and groups registered across your channel platforms. The id values from these commands are what yachiyo send channel takes.

Terminal window
yachiyo channel users [--json]

Compact output:

[allowed] telegram:alice id=a1b2c3d4-...
[pending] qq:bob id=e5f6g7h8-...

With --json, full records:

[
{
"id": "a1b2c3d4-...",
"platform": "telegram",
"externalUserId": "123456",
"username": "alice",
"status": "allowed",
"role": "guest",
"usageLimitKTokens": null,
"usedKTokens": 42,
"workspacePath": "/tmp/yachiyo/tg-alice"
}
]
FieldDescription
idInternal UUID — pass this to send channel
platformtelegram, qq, or discord
externalUserIdTheir ID on the platform
usernameDisplay name
statuspending, allowed, or blocked
roleowner or guest
usageLimitKTokensToken quota; null means unlimited
usedKTokensAccumulated usage
workspacePathThis user’s sandboxed workspace
Terminal window
yachiyo channel groups [--json]
[approved] discord:dev-chat id=x9y8z7w6-...
[pending] qq:test-group id=m1n2o3p4-...
FieldDescription
idInternal UUID
platformtelegram, qq, or discord
externalGroupIdThe group’s ID on the platform
nameDisplay name
statuspending, approved, or blocked
workspacePathThe group’s sandboxed workspace
createdAtWhen the group was registered
Terminal window
yachiyo channel groups set-status <id> <status>

Accepted values: approved or approval, pending, blocked or block.

Terminal window
yachiyo channel groups set-status x9y8z7w6-... approval # start monitoring
yachiyo channel groups set-status x9y8z7w6-... block # stop monitoring

If the app is running, the change goes over the Unix socket and applies immediately — approval starts the group monitor right away, block stops it. If the app is not running, the database record is updated directly instead.

This command is group-only. Passing a channel user ID fails with Unknown channel group.

channel users set-label / channel groups set-label

Section titled “channel users set-label / channel groups set-label”
Terminal window
yachiyo channel users set-label <id> <label>
yachiyo channel groups set-label <id> <label>

Attaches a descriptive label. Labels are what the agent uses to work out who a contact is or what a group is for, so “Design team standup” beats leaving it blank.

  • Channels — platform setup and the guest model
  • yachiyo send — deliver a message to one of these IDs