GH-COPILOT(1)

✨ GH-COPILOT 💅 (that's the gh-copilot page, bestie — GitHub CLI manual energy)

okay so you wanna run the GitHub Copilot CLI? say less. this is the whole page, no gatekeeping 🫶

---

🌸 SYNOPSIS

gh copilot [flags] [args]

🦋 DESCRIPTION

So basically it runs the GitHub Copilot CLI. that's it, that's the vibe.

🚨 real talk: running the Copilot CLI through gh is currently in preview and subject to change. so like... don't build your whole personality on it yet, k?

If you already have it installed, gh will execute the Copilot CLI it finds in your PATH. if you don't have it installed, it gets downloaded to /home/abuild/.local/share/gh/copilot — iconic, it just handles it for you 💖

and if you want that downloaded Copilot CLI gone, hit it with --remove. bye bestie 👋

heads up on compatibility: this command is only supported on Windows, Linux, and Darwin, and only on amd64/x64 or arm64 architectures. no cap, that's the whole guest list.

Oh and super important — to stop gh from interpreting flags that are actually meant for Copilot, put -- before the Copilot flags and args. otherwise gh is gonna be all up in your business reading them itself 😭

wanna learn more? go look at https://gh.io/copilot-cli — the link is literally right there, iykyk ⭐

🎀 OPTIONS

• --remove — removes the downloaded Copilot CLI. that's the only one, she's simple and she knows it 💅

💀 EXIT CODES

• 0: successful execution ✨
• 1: error 🙈
• 2: command canceled
• 4: authentication required 🔐

📝 NOTE: specific commands may have additional exit codes — go check that command's help for the details, fr fr.

🔥 EXAMPLE

download it and run it, no thoughts head empty:

# Download and run the Copilot CLI
$ gh copilot

running it with a prompt and letting it use the shell tool (main character energy):

# Run the Copilot CLI
$ gh copilot -p "Summarize this week's commits" --allow-tool 'shell(git)'

removing it — but only if you installed it through gh, remember that:

# Remove the Copilot CLI (if installed through gh)
$ gh copilot --remove

and getting the Copilot help command itself, using that -- we talked about:

# Run the Copilot CLI help command
$ gh copilot -- --help

🌈 SEE ALSO

• gh(1) — the mothership 🫶

---

that's the whole page, you ate it up 💜 this lil drop is from GitHub CLI v2.102.0, dated Oct 2026 — go forth and vibe check your way through Copilot, bestie 🧚‍♀️🌸