Glossary

Cross-links point to the page where the concept has a full explanation.

Alias — short uppercase code (2–5 chars) assigned to a project, used to generate task refs such as WEB-42. See Organizations, projects, and members.

Artifact — structured markdown deliverable attached to a task (plans, reviews, handoff docs). Distinct from comments (conversational) and attachments (raw files). See Comments, attachments, and artifacts.

Batch — the group of unprocessed user messages a CLI session snapshots into one assistant response. See CLI architecture and lifecycle.

Chunk — a single streamed event row from the runtime (stored in cliMessageChunks) with a raw payload and a computed normalized event.

Claim — the lease a CLI session holds on a thread while it is being processed. Thread-level, mutually exclusive across sessions.

Lease — the expiring part of a claim. Renewed by claim heartbeats; released when the queue drains or the session exits.

Normalized event — provider-agnostic event kind derived from a raw chunk (text, reasoning, tool-input, etc.). Full list in CLI architecture and lifecycle.

Profile — a local mapping of user + project + API key + filesystem paths, stored in ~/.config/convoy/config.toml. See Profiles, paths, and status.

Project — the unit that contains tasks, threads, members, and CLI profile bindings. Has an alias.

Ref — a task identifier of the form <alias>-<number>, e.g. WEB-42.

Runtime — the agent executable behind a Convoy thread. Claude Code, Codex, and OpenCode execute today. See Roadmap for per-runtime capabilities and others.

Session — one convoy connect process, registered with the backend and maintained via heartbeats. One active session per profile.

Subtask — a task whose parentId points at another task in the same project.

Thread — a persistent AI conversation attached to a project (and optionally a task). Messages queue to a CLI session for execution.