kylon workspace room — kylon workspace help detail
room — conversation contexts
kylon workspace room list [--query <keyword>] [--writable]
Default: list rooms the agent can read and write in this session — the rooms it has joined, plus the current room. --writable lists the same set (kept for compatibility).
--query: case-insensitive substring match on room name or writable DM display name.
kylon workspace room discover [--query <keyword>] [--limit <n>] [--offset <n>]
Search public topic rooms the current user can join. Returns room IDs and joined status.
Paged: defaults to 25 results and reports the total when more match. Narrow with --query rather than paging through everything.
kylon workspace room join <room_id>
Join a public topic room as the current user or agent. Use room discover first to find joinable room IDs.
kylon workspace room leave <room_id>
Leave a joined topic room as the current user or agent. Cannot leave DMs, the default all-members room (or legacy general), or rooms where you are the only human admin.
kylon workspace room get <room_id>
kylon workspace room create <name> --scope public|private [--main-agent <agent_id>] [--task <text>] [--context <text>] [--guideline <text>] [--members <user_id,...>] [--icon-color <color>] [--external-operator-ack true]
--scope is required. Public rooms are visible and joinable by workspace members. Private rooms are visible only to invited members.
Binding or seeding an external agent whose operator cannot read the room requires explicit operator-consent acknowledgement: without --external-operator-ack true the command is refused before anything is created and reports which agent, operator, and computer need consent. Pass the flag only after the requesting human has explicitly confirmed that room content may flow to that operator's computer.
--main-agent is optional. When omitted, the room is created without a main agent; pass --main-agent to bind one.
When confirming with a kylon workspace ui send card first, prefill useful defaults (slug-like name, likely scope, likely default agent, requesting/named members, short guideline) and build the form with a radio_group public/private (allowOther=false), a workspace_agent_picker (single, allowNone) for the optional agent, and a workspace_member_picker (multiple) for private members; end with a summary card and a Create button, then run this command.
--icon-color is optional. Omit it for automatic selection; the backend avoids colors already used by active rooms when possible. If choosing manually, run room list first and pick a different iconColor.
Available colors: rose, orange, yellow, green, teal, cyan, blue, indigo, purple, pink.
kylon workspace room update <room_id> [--name <name>] [--guideline <text>] [--avatar <workspace_file_path>] [--remove-avatar] [--icon-color <color>]
--avatar: workspace path returned by kylon workspace file upload --source <local_path> --dest <workspace_file_path>
(e.g. shared/room-avatar.png). Supported formats: png, jpg, jpeg, gif, webp, svg. Max 2 MB.
kylon workspace room archive <room_id>
kylon workspace room unarchive <room_id>
kylon workspace room member list <room_id>
List all members of a room with their display name, user ID, type, and relation.
kylon workspace room member add <room_id> --members <user_id,...> [--relation <admin|member>] [--external-operator-ack true]
Add one or more workspace members to the room. Defaults to "member" relation.
Adding an external agent whose operator cannot read the room is refused until the add carries --external-operator-ack true. Pass the flag only after the requesting human has explicitly confirmed the operator-consent requirement reported by the refusal.
kylon workspace room member remove <room_id> --members <user_id,...>
Remove one or more members from the room. Requires room admin.
Resource link handoff:
- Emit identified Kylon resources as clickable, path-only markdown links with human-readable labels.
- Copy command-returned links verbatim. Otherwise substitute known IDs into the relevant format below; do not guess a path.
- Room: `[name](/workspaces/{workspaceId}/rooms/{roomId})`
Note: quote flag values that contain spaces; follow each command's JSON syntax.
Workspace commands
room
List, create, join, update, and manage rooms.