Skip to content

Commit 65f1115

Browse files
committed
docs: update README and agents
1 parent b8a6095 commit 65f1115

2 files changed

Lines changed: 37 additions & 13 deletions

File tree

AGENTS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,24 @@ CodexMonitor is a macOS Tauri app that orchestrates Codex agents across local wo
77

88
- `src/App.tsx`: composition root
99
- `src/components/`: presentational UI components
10+
- `src/components/SettingsView.tsx`: settings UI (projects, display, Codex)
11+
- `src/components/UpdateToast.tsx`: in-app updater UI
12+
- `src/components/Home.tsx`: home dashboard + latest agent runs
1013
- `src/hooks/`: state + event wiring
14+
- `src/hooks/useAppSettings.ts`: app settings load/save + doctor
15+
- `src/hooks/useUpdater.ts`: update checks + install flow
16+
- `src/hooks/useResizablePanels.ts`: panel resize + persistence
17+
- `src/hooks/useComposerImages.ts`: image attachment state
18+
- `src/hooks/useComposerImageDrop.ts`: drag/drop + paste images
19+
- `src/hooks/useGitHubIssues.ts`: GitHub issues tab data
1120
- `src/utils/threadItems.ts`: thread item normalization + conversion
1221
- `src/services/tauri.ts`: Tauri IPC wrapper
1322
- `src/styles/`: split CSS by area
1423
- `src/types.ts`: shared types
1524
- `src-tauri/src/lib.rs`: backend app-server client
25+
- `src-tauri/src/git.rs`: git status/log/diff + GitHub issues via `gh`
26+
- `src-tauri/src/settings.rs`: app settings persistence
27+
- `src-tauri/src/prompts.rs`: custom prompt discovery/parsing
1628
- `src-tauri/tauri.conf.json`: window config + effects
1729

1830
## Architecture Guidelines
@@ -73,7 +85,9 @@ to the next minor version.
7385
- UI layout or styling: update `src/components/*` and `src/styles/*`.
7486
- App-server event handling: edit `src/hooks/useAppServerEvents.ts`.
7587
- Tauri IPC: add wrappers in `src/services/tauri.ts` and implement in `src-tauri/src/lib.rs`.
88+
- App settings or updater behavior: `src/hooks/useAppSettings.ts`, `src/hooks/useUpdater.ts`, and `src/components/SettingsView.tsx`.
7689
- Git diff behavior: `src/hooks/useGitStatus.ts` (polling + activity refresh) and `src-tauri/src/lib.rs` (libgit2 status).
90+
- GitHub issues panel: `src/hooks/useGitHubIssues.ts` + `src-tauri/src/git.rs`.
7791
- Thread history rendering: `src/hooks/useThreads.ts` converts `thread/resume` turns into UI items.
7892
- Thread names update on first user message (preview-based), and on resume if a preview exists.
7993
- Thread item parsing/normalization: `src/utils/threadItems.ts`.
@@ -84,3 +98,7 @@ to the next minor version.
8498
- The window uses `titleBarStyle: "Overlay"` and macOS private APIs for transparency.
8599
- Avoid breaking the JSON-RPC format; app-server rejects requests before initialization.
86100
- The debug panel is UI-only; it logs client/server/app-server events from `useAppServerEvents`.
101+
- App settings live in `settings.json` under the app data directory (Codex path, default access mode, UI scale).
102+
- UI preferences (panel sizes, reduced transparency toggle, recent thread activity) live in `localStorage`.
103+
- GitHub issues require `gh` to be installed and authenticated.
104+
- Custom prompts are loaded from `$CODEX_HOME/prompts` (or `~/.codex/prompts`) and support optional frontmatter metadata.

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,33 @@
44

55
CodexMonitor is a macOS Tauri app for orchestrating multiple Codex agents across local workspaces. It provides a sidebar to manage projects, a home screen for quick actions, and a conversation view backed by the Codex app-server protocol.
66

7-
## Features (MVP)
8-
9-
- Add and persist workspaces using the system folder picker.
10-
- Spawn one `codex app-server` per workspace and stream events over JSON-RPC.
11-
- Restore threads per workspace from the Codex rollout history (`thread/list`) and resume on selection.
12-
- Start agent threads, send messages, show reasoning/tool call items, and handle approvals.
13-
- Worktree agents per workspace (create/delete git worktrees under `.codex-worktrees`).
14-
- Git panel with diff stats, file diffs, and commit log; open commits on GitHub when a remote is detected.
7+
## Features
8+
9+
- Add and persist workspaces with a home dashboard of recent agent activity.
10+
- Spawn one `codex app-server` per workspace, stream JSON-RPC events, and resume threads on selection.
11+
- Start agent threads, send messages, render reasoning/tool/diff items, and handle approvals.
12+
- Worktree agents per workspace (create/delete git worktrees under `.codex-worktrees`) with quick worktree info.
13+
- Git panel with diff stats, file diffs, commit log, and GitHub Issues (via `gh`); open commits on GitHub when a remote is detected.
1514
- Branch list with checkout and create flows.
1615
- Model picker, reasoning effort selector, access mode (read-only/current/full-access), and context usage ring.
17-
- Skills menu and composer autocomplete for `$skill`, `/prompts:...`, and `@file` tokens (custom prompts pulled from `~/.codex/prompts`).
18-
- Plan panel for per-turn planning updates and turn interruption controls.
16+
- Skills menu and composer autocomplete for `$skill`, `/prompts:...`, `/review ...`, and `@file` tokens.
17+
- Plan panel for per-turn planning updates plus turn interrupt controls.
1918
- Review runs against uncommitted changes, base branch, commits, or custom instructions.
20-
- Debug panel for warning/error events and clipboard export.
19+
- Debug panel for warning/error events with clipboard export.
2120
- Sidebar usage + credits meter for account rate limits.
22-
- Archive threads (removes from UI and calls `thread/archive`).
23-
- macOS overlay title bar with vibrancy effects.
21+
- Composer queueing plus image attachments (picker, drag/drop, paste) with per-thread drafts.
22+
- Resizable sidebar/right/plan/debug panels with persisted sizes.
23+
- Responsive layouts for desktop/tablet/phone with tabbed navigation.
24+
- In-app updater with toast-driven download/install.
25+
- macOS overlay title bar with vibrancy effects and optional reduced transparency.
2426

2527
## Requirements
2628

2729
- Node.js + npm
2830
- Rust toolchain (stable)
2931
- Codex installed on your system and available as `codex` in `PATH`
3032
- Git CLI (used for worktree operations)
33+
- GitHub CLI (`gh`) for the Issues panel (optional)
3134

3235
If the `codex` binary is not in `PATH`, update the backend to pass a custom path per workspace.
3336

@@ -82,12 +85,15 @@ src-tauri/
8285
## Notes
8386

8487
- Workspaces persist to `workspaces.json` under the app data directory.
88+
- App settings persist to `settings.json` under the app data directory (Codex path, default access mode, UI scale).
8589
- On launch and on window focus, the app reconnects and refreshes thread lists for each workspace.
8690
- Threads are restored by filtering `thread/list` results using the workspace `cwd`.
8791
- Selecting a thread always calls `thread/resume` to refresh messages from disk.
8892
- CLI sessions appear if their `cwd` matches the workspace path; they are not live-streamed unless resumed.
8993
- The app uses `codex app-server` over stdio; see `src-tauri/src/lib.rs`.
9094
- Worktree agents live in `.codex-worktrees/` and are removed on delete; the root repo gets a `.gitignore` entry.
95+
- UI state (panel sizes, reduced transparency toggle, recent thread activity) is stored in `localStorage`.
96+
- Custom prompts load from `$CODEX_HOME/prompts` (or `~/.codex/prompts`) with optional frontmatter description/argument hints.
9197

9298
## Tauri IPC Surface
9399

0 commit comments

Comments
 (0)