One-shot commands

Use the CLI as a scriptable interface for organizations, projects, agents, tasks, and artifacts.

One-shot commands run once, print results, and exit.

Main areas

convoy orgs list
convoy projects list
convoy task-types list
convoy project-agents list|create|update
convoy prompts list|create|update
convoy skills list|show|create|update|remove
convoy tasks list
convoy tasks search
convoy tasks get
convoy tasks refs
convoy tasks create
convoy tasks update
convoy tasks move
convoy tasks move-to-list
convoy tasks comments add
convoy tasks delete
convoy tasks artifacts ...
convoy profiles list
convoy threads list|get|messages

Output modes

Use text output for humans:

convoy tasks list

Use JSON output for scripts:

convoy tasks search "billing bug" --output json

Examples

convoy projects list
convoy tasks list --status "In Progress"
convoy tasks search "search dropdown"
convoy tasks create --name "Fix login bug" --project WEB --org acme
convoy tasks move WEB-12 --parent WEB-42 --project WEB --org acme
convoy task-types list --project WEB
convoy project-agents list --project WEB
convoy prompts list --scope organization --org acme
convoy skills list --project WEB
convoy skills list --scope organization --org acme
convoy tasks comments add WEB-12 --message "Ready for review" --project WEB
convoy tasks move-to-list WEB-12 WEB-42 --list SPRINT-1 --project WEB

Full command surface

This page shows the shape; every command and flag (including --limit / --cursor pagination) is cataloged in the CLI command reference.

Best use cases

shell scripts
CI helpers
editor tasks
quick terminal workflows without opening the web UI