Document project-scoped terminal pet selection with [tui].pet

Open Beginner friendly
#36,758 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
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Domain
cli, documentation

Research direction

Start with the pets, configuration reference, and config basics pages linked in the issue, then compare their existing /pets and configuration descriptions. Document tui.pet, identifier formats, trusted project .codex/config.toml placement, and user-level persistence from /pets; done when all four distinctions are clear.

Written by the indexing model from the issue text.

Description

CLI config documentation pets TUI
What is the type of issue?

Documentation is missing

What is the issue?

Codex supports project-scoped terminal pet selection, but the current documentation only describes choosing a terminal pet through /pets, and the configuration reference does not list tui.pet.

This makes pet selection appear user-global, especially because the /pets picker persists its selection to the user configuration.

On codex-cli 0.146.0, I verified that a project configuration can override the user-selected pet:

# <project>/.codex/config.toml
[tui]
pet = "custom:my-project-pet"

A config/read request resolved the project pet as the effective value and attributed tui.pet to the project .codex layer.

Please document:

  • tui.pet in the configuration reference;
  • the required identifier format for built-in and custom pets;
  • that it may be placed in a trusted project’s .codex/config.toml;
  • that /pets writes the user-level selection rather than the project override.
Where did you find it?
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.