GH-AGENT-TASK-CREATE(1)

GH-AGENT-TASK-CREATE(1) 🦋

✨ NAME ✨

gh-agent-task-create — create an agent task (preview). This page is from the GitHub CLI manual, bestie, and yes it's giving preview energy, so keep that in mind. 💅

🌸 SYNOPSIS 🌸

gh agent-task create [<task description>] [flags]

okay so you can hand over a <task description> if you want, or not — it's optional, no pressure — and then the [flags] do their little thing. 🎀

💅 OPTIONS 💅

• -b, --base <string> — base branch for the pull request. If you don't provide one, it uses the default branch, periodt.
• -a, --custom-agent <string> — use a custom agent for the task. e.g., use 'my-agent' for the 'my-agent.md' agent. iykyk.
• --follow — follow agent session logs. lowkey useful.
• -F, --from-file <file> — read the task description from a file. Use "-" to read from standard input — yes, the dash is doing main character work.
• -R, --repo <[HOST/]OWNER/REPO> — select another repository using the [HOST/]OWNER/REPO format. slay.

💖 EXIT CODES 💖

• 0: Successful execution
• 1: Error
• 2: Command canceled
• 4: Authentication required

NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information.

🔥 EXAMPLE 🔥

okay bestie, here are all the examples exactly as the manual gives them — copy-paste energy only:

# Create a task from an inline description
$ gh agent-task create "build me a new app"

# Create a task from an inline description and follow logs
$ gh agent-task create "build me a new app" --follow

# Create a task from a file
$ gh agent-task create -F task-desc.md

# Create a task with problem statement from stdin
$ echo "build me a new app" | gh agent-task create -F -

# Create a task with an editor
$ gh agent-task create

# Create a task with an editor and a file as a template
$ gh agent-task create -F task-desc.md

# Select a different base branch for the PR
$ gh agent-task create "fix errors" --base branch

# Create a task using the custom agent defined in '.github/agents/my-agent.md'
$ gh agent-task create "build me a new app" --custom-agent my-agent

🌈 SEE ALSO 🌈

• gh-agent-task(1)

---

stay iconic, bestie 💖 — GitHub CLI v2.102.0, Oct 2026 🎀