From 33d0d73b822abeae87cec07f2c2901ff900e434f Mon Sep 17 00:00:00 2001
From: Tomas Cupr <work@tomcupr.com>
Date: Thu, 17 Apr 2025 01:34:44 +0200
Subject: [PATCH] feat: add shell completion subcommand (#138)

Why
---
Improves the usability of the `codex` CLI by adding shell completion for
file paths. This allows users to quickly complete file arguments using
tab completion in bash, zsh, and fish shells. Enable via `eval "$(codex
completion <shell>)"`.
---
 README.md             |  1 +
 codex-cli/src/cli.tsx | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)

diff --git a/README.md b/README.md
index 1f9b1fca..2588c303 100644
--- a/README.md
+++ b/README.md
@@ -153,6 +153,7 @@ Both approaches are _transparent_ to everyday usage – you still run `codex` fr
 | `codex`        | Interactive REPL                    | `codex`                              |
 | `codex "…"`    | Initial prompt for interactive REPL | `codex "fix lint errors"`            |
 | `codex -q "…"` | Non‑interactive "quiet mode"        | `codex -q --json "explain utils.ts"` |
+| `codex completion <bash|zsh|fish>` | Print shell completion script    | `codex completion bash`               |
 
 Key flags: `--model/-m`, `--approval-mode/-a`, and `--quiet/-q`.
 
diff --git a/codex-cli/src/cli.tsx b/codex-cli/src/cli.tsx
index d4b661f6..2f578980 100644
--- a/codex-cli/src/cli.tsx
+++ b/codex-cli/src/cli.tsx
@@ -45,6 +45,7 @@ const cli = meow(
   `
   Usage
     $ codex [options] <prompt>
+    $ codex completion <bash|zsh|fish>
 
   Options
     -h, --help                 Show usage and exit
@@ -74,6 +75,7 @@ const cli = meow(
   Examples
     $ codex "Write and run a python program that prints ASCII art"
     $ codex -q "fix build issues"
+    $ codex completion bash
 `,
   {
     importMeta: import.meta,
@@ -136,6 +138,38 @@ const cli = meow(
   },
 );
 
+// Handle 'completion' subcommand before any prompting or API calls
+if (cli.input[0] === 'completion') {
+  const shell = cli.input[1] || 'bash';
+  const scripts: Record<string,string> = {
+    bash: `# bash completion for codex
+_codex_completion() {
+  local cur
+  cur="\${COMP_WORDS[COMP_CWORD]}"
+  COMPREPLY=( $(compgen -o default -o filenames -- "\${cur}") )
+}
+complete -F _codex_completion codex`,
+    zsh: `# zsh completion for codex
+#compdef codex
+
+_codex() {
+  _arguments '*:filename:_files'
+}
+_codex`,
+    fish: `# fish completion for codex
+complete -c codex -a '(_fish_complete_path)' -d 'file path'`,
+  };
+  const script = scripts[shell];
+  if (!script) {
+    // eslint-disable-next-line no-console
+    console.error(`Unsupported shell: ${shell}`);
+    process.exit(1);
+  }
+  // eslint-disable-next-line no-console
+  console.log(script);
+  process.exit(0);
+}
+// Show help if requested
 if (cli.flags.help) {
   cli.showHelp();
 }