exec_command tool description says every command runs in a PTY

Open Beginner friendly
#25,562 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
rust
Domain
cli, documentation

Research direction

Start by locating the exec_command tool description and its tty parameter schema, then compare both with the documented default behavior. Update the top-level wording so it accurately describes pipe-based execution by default and PTY behavior only when tty is true; verify that the description and schema are consistent.

Written by the indexing model from the issue text.

Description

documentation tool-calls
What happened?

The exec_command tool description says:

Runs a command in a PTY, returning output or a session ID for ongoing interaction.

But the same tool schema documents the tty parameter as:

True allocates a PTY for the command; false or omitted uses plain pipes.

The implementation defaults tty to false, and the process manager uses the non-PTY spawn path unless tty is true.

This makes the top-level tool description misleading: most commands do not run in a PTY unless requested.

Expected behavior

The tool description should describe the default pipe behavior and reserve PTY wording for tty: true, or otherwise match the actual default execution mode.

Additional context

I searched open issues and PRs for terms including exec_command, PTY, pipes, tty, and tool description, and did not find an existing open item that appears to cover this description mismatch.

Dominant language
Rust
Stars
125k
Forks
19.5k
Avg merge
1m
Merged PRs (30d)
1k

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openai/codex

All issues in openai/codex

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.