Skip to content

Commit a92fd4c

Browse files
committed
docs: refresh README and skill metadata
1 parent d38b848 commit a92fd4c

3 files changed

Lines changed: 39 additions & 40 deletions

File tree

.agents/skills/codex-upstream-reapply/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: codex-upstream-reapply
3-
description: "Tag-based upstream sync for a fork/secondary-development repo: by default auto-pick the latest stable rust-vX.Y.Z tag and current branch, create a fresh branch from that tag, then read the old customization branch’s git changes + intent Markdown to re-implement the requirements on the new branch (no merge/rebase of the old branch)."
3+
description: 'Reapply a fork or secondary-development branch onto the latest stable rust-vX.Y.Z tag by creating a fresh branch from that tag and re-implementing the old branch intent without merge or rebase.'
44
---
55

66
# Codex Upstream Reapply

.agents/skills/status-header/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: status-header
3-
description: Enforce the standard TUI status header layout, icons, colors, and rate-limit summary format when implementing or editing the status header (ratatui Line/Span), and keep equivalent `tui` / `tui_app_server` surfaces aligned.
3+
description: 'Enforce the standard TUI status header layout, icons, colors, and rate-limit summary format, and keep equivalent tui and tui_app_server surfaces aligned.'
44
---
55

66
# Status Header

README.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,51 @@ An opinionated Codex CLI. This is strictly a personal hobby project, forked from
77
![TUI](
88
https://github.com/user-attachments/assets/127abbc2-cb30-4d6e-8a81-ce707260c045)
99

10+
> [!IMPORTANT]
11+
> **DO NOT USE IN PRODUCTION.**
12+
> To keep upstream sync easy, we do not write test code for what we changed. This project is for experimental use only.
13+
14+
* **DX Focused:** Focus strictly on optimizing developer experience, **without adding new features**.
15+
* **Upstream Sync:** We sync with the upstream repository regularly.
16+
1017
## Quick Start
1118

12-
Build from source:
19+
Choose one of these two ways:
20+
21+
* Install from npm:
22+
23+
```shell
24+
npm i -g @loongphy/codext
25+
```
26+
27+
* Build from source:
1328

1429
```shell
1530
cd codex-rs
1631
cargo run --bin codex
1732
```
1833

34+
## Features
35+
36+
> Full change log: see [CHANGED.md](./CHANGED.md).
37+
38+
* `Ctrl+Shift+C` in the TUI composer copies the current draft to the system clipboard; `Ctrl+C` keeps its existing behavior, and empty drafts still fall back to the old `Ctrl+C` path.
39+
* TUI status header with model/effort, cwd, git summary, and rate-limit status.
40+
* Collaboration mode presets accept per-mode overrides and default to the active `/model` settings. Example:
41+
42+
```toml
43+
# config.toml
44+
[collaboration_modes.plan]
45+
model = "gpt-5.4"
46+
reasoning_effort = "xhigh"
47+
48+
[collaboration_modes.code]
49+
model = "gpt-5.4"
50+
```
51+
52+
* TUI watches `auth.json` for external login changes and reloads auth automatically, with a warning on account switch. This works well with [codex-auth](https://github.com/Loongphy/codex-auth) when you refresh or switch login state outside the TUI.
53+
* AGENTS.md and project-doc instructions are refreshed on each new user turn, and Codex shows an explicit warning when a refresh is applied.
54+
1955
## Project Goals
2056

2157
We will never merge code from the upstream repo; instead, we re-implement our changes on top of the latest upstream code.
@@ -33,43 +69,6 @@ flowchart TD
3369
G --> H[Force-push to fork main]
3470
```
3571

36-
> [!IMPORTANT]
37-
> **DO NOT USE IN PRODUCTION.**
38-
> To keep upstream sync easy, we do not write test code for what we changed. This project is for experimental use only.
39-
40-
* **DX Focused:** Focus strictly on optimizing developer experience, **without adding new features**.
41-
* **Upstream Sync:** We sync with the upstream repository regularly.
42-
43-
## What Changed
44-
45-
* Added `Ctrl+Shift+C` in the TUI composer to copy the current draft to the system clipboard; `Ctrl+C` keeps its existing behavior, and empty drafts still fall back to the old `Ctrl+C` path.
46-
* On WSL2, TUI draft copy reuses the existing Windows clipboard fallback so copied drafts still land in the Windows system clipboard.
47-
* Added a TUI status header with model/effort, cwd, git summary, and rate-limit status.
48-
* Collaboration mode presets now accept per-mode overrides and default to the active `/model` settings.
49-
* TUI watches `auth.json` for external login changes and reloads auth automatically (with a warning on account switch).
50-
* AGENTS.md/project-doc instructions are refreshed on each new user turn, and Codex shows an explicit warning when a refresh is applied.
51-
* Full change log: see [CHANGED.md](./CHANGED.md).
52-
53-
## AGENT Local development check
54-
55-
1. DO NOT update any test codes
56-
2. After making code changes, verify the CLI still launches:
57-
58-
```shell
59-
cd ./codex-rs
60-
cargo run --bin codex
61-
```
62-
63-
```toml
64-
# config.toml
65-
[collaboration_modes.plan]
66-
model = "gpt-5.4"
67-
reasoning_effort = "xhigh"
68-
69-
[collaboration_modes.code]
70-
model = "gpt-5.4"
71-
```
72-
7372
## Skills
7473

7574
When syncing to the latest upstream codex version, use `.agents/skills/codex-upstream-reapply` to re-implement our custom requirements on top of the newest code, avoiding merge conflicts from the old branch history.

0 commit comments

Comments
 (0)