mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-04 01:40:45 +08:00
c6093ef741
- Implemented CliCommandNode component for executing CLI tools with AI models. - Implemented PromptNode component for constructing AI prompts with context. - Added styling for mode and tool badges in both components. - Enhanced user experience with command and argument previews, execution status, and error handling. test: add comprehensive tests for ask_question tool - Created direct test for ask_question tool execution. - Developed end-to-end tests to validate ask_question tool integration with WebSocket and A2UI surfaces. - Implemented simple and integrated WebSocket tests to ensure proper message handling and surface reception. - Added tool registration test to verify ask_question tool is correctly registered. chore: add WebSocket listener and simulation tests - Added WebSocket listener for A2UI surfaces to facilitate testing. - Implemented frontend simulation test to validate complete flow from backend to frontend. - Created various test scripts to ensure robust testing of ask_question tool functionality.
78 lines
56 KiB
HTML
78 lines
56 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-commands/cli/codex-review" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">/cli:codex-review | CCW Help Documentation</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="http://localhost:3001/docs/docs/commands/cli/codex-review"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" property="og:locale:alternate" content="zh"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="/cli:codex-review | CCW Help Documentation"><meta data-rh="true" name="description" content="Interactive code review using Codex CLI with configurable review targets"><meta data-rh="true" property="og:description" content="Interactive code review using Codex CLI with configurable review targets"><link data-rh="true" rel="icon" href="/docs/img/favicon.ico"><link data-rh="true" rel="canonical" href="http://localhost:3001/docs/docs/commands/cli/codex-review"><link data-rh="true" rel="alternate" href="http://localhost:3001/docs/docs/commands/cli/codex-review" hreflang="en"><link data-rh="true" rel="alternate" href="http://localhost:3001/docs/zh/docs/commands/cli/codex-review" hreflang="zh"><link data-rh="true" rel="alternate" href="http://localhost:3001/docs/docs/commands/cli/codex-review" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"/cli:codex-review","item":"http://localhost:3001/docs/docs/commands/cli/codex-review"}]}</script><link rel="stylesheet" href="/docs/assets/css/styles.43777f0a.css">
|
||
<script src="/docs/assets/js/runtime~main.0220a52f.js" defer="defer"></script>
|
||
<script src="/docs/assets/js/main.d2194b90.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/docs/"><div class="navbar__logo"><img src="/docs/img/logo.svg" alt="CCW Logo" class="themedComponent_DHUr themedComponent--light_DIHH"><img src="/docs/img/logo.svg" alt="CCW Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></div><b class="navbar__title text--truncate">CCW Help</b></a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_xrmG"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/docs/docs/commands/cli/codex-review" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/docs/zh/docs/commands/cli/codex-review" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh">中文</a></li></ul></div><div class="toggle_OLSw colorModeToggle_Hg9V"><button class="clean-btn toggleButton_wYmb toggleButtonDisabled_vaDU" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_KEbZ lightToggleIcon_Sxwe"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_KEbZ darkToggleIcon_Yem1"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_KEbZ systemToggleIcon_txm5"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_bmvg"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_UyTV"><div class="docsWrapper_XLvK"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docRoot_HciC"><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class="sidebarViewport_N8x0"><div class="sidebar_vJCc"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/docs/overview"><span title="Overview" class="linkLabel_PuAu">Overview</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_d9ci menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/docs/docs/commands/general/ccw"><span title="Commands" class="categoryLinkLabel_Oe72">Commands</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_d9ci menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="true" tabindex="0" href="/docs/docs/commands/general/ccw"><span title="General Commands" class="categoryLinkLabel_Oe72">General Commands</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/general/ccw"><span title="/ccw" class="linkLabel_PuAu">/ccw</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/general/ccw-plan"><span title="/ccw-plan" class="linkLabel_PuAu">/ccw-plan</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/general/ccw-test"><span title="/ccw-test" class="linkLabel_PuAu">/ccw-test</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/general/ccw-coordinator"><span title="/ccw-coordinator" class="linkLabel_PuAu">/ccw-coordinator</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/general/ccw-debug"><span title="/ccw-debug" class="linkLabel_PuAu">/ccw-debug</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/general/flow-create"><span title="/flow-create" class="linkLabel_PuAu">/flow-create</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/general/codex-coordinator"><span title="/codex-coordinator" class="linkLabel_PuAu">/codex-coordinator</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_d9ci menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="true" tabindex="0" href="/docs/docs/commands/issue/issue-new"><span title="Issue Commands" class="categoryLinkLabel_Oe72">Issue Commands</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/issue/issue-new"><span title="issue:new" class="linkLabel_PuAu">issue:new</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/issue/issue-discover"><span title="issue:discover" class="linkLabel_PuAu">issue:discover</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/issue/issue-plan"><span title="issue:plan" class="linkLabel_PuAu">issue:plan</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/issue/issue-queue"><span title="issue:queue" class="linkLabel_PuAu">issue:queue</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/issue/issue-execute"><span title="issue:execute" class="linkLabel_PuAu">issue:execute</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/issue/issue-from-brainstorm"><span title="issue:from-brainstorm" class="linkLabel_PuAu">issue:from-brainstorm</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/issue/issue-convert-to-plan"><span title="issue:convert-to-plan" class="linkLabel_PuAu">issue:convert-to-plan</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_d9ci menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/docs/docs/commands/cli/cli-init"><span title="CLI Commands" class="categoryLinkLabel_Oe72">CLI Commands</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/cli/cli-init"><span title="/cli:cli-init" class="linkLabel_PuAu">/cli:cli-init</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/docs/commands/cli/codex-review"><span title="/cli:codex-review" class="linkLabel_PuAu">/cli:codex-review</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_d9ci menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="true" tabindex="0" href="/docs/docs/commands/memory/memory-update-full"><span title="Memory Commands" class="categoryLinkLabel_Oe72">Memory Commands</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-update-full"><span title="/memory:update-full" class="linkLabel_PuAu">/memory:update-full</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-update-related"><span title="/memory:update-related" class="linkLabel_PuAu">/memory:update-related</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-load"><span title="/memory:load" class="linkLabel_PuAu">/memory:load</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-docs-full-cli"><span title="/memory:docs-full-cli" class="linkLabel_PuAu">/memory:docs-full-cli</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-docs-related-cli"><span title="/memory:docs-related-cli" class="linkLabel_PuAu">/memory:docs-related-cli</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-compact"><span title="/memory:compact" class="linkLabel_PuAu">/memory:compact</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_d9ci menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="true" tabindex="0" href="/docs/docs/commands/memory/memory-update-full"><span title="Memory Commands" class="categoryLinkLabel_Oe72">Memory Commands</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-update-full"><span title="/memory:update-full" class="linkLabel_PuAu">/memory:update-full</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-update-related"><span title="/memory:update-related" class="linkLabel_PuAu">/memory:update-related</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-load"><span title="/memory:load" class="linkLabel_PuAu">/memory:load</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-docs-full-cli"><span title="/memory:docs-full-cli" class="linkLabel_PuAu">/memory:docs-full-cli</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-docs-related-cli"><span title="/memory:docs-related-cli" class="linkLabel_PuAu">/memory:docs-related-cli</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/commands/memory/memory-compact"><span title="/memory:compact" class="linkLabel_PuAu">/memory:compact</span></a></li></ul></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_d9ci menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="true" href="/docs/docs/workflows/introduction"><span title="Workflows" class="categoryLinkLabel_Oe72">Workflows</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/workflows/introduction"><span title="Introduction" class="linkLabel_PuAu">Introduction</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/workflows/level-1-ultra-lightweight"><span title="Level 1: Ultra Lightweight" class="linkLabel_PuAu">Level 1: Ultra Lightweight</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/workflows/level-2-rapid"><span title="Level 2: Rapid" class="linkLabel_PuAu">Level 2: Rapid</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/workflows/level-3-standard"><span title="Level 3: Standard" class="linkLabel_PuAu">Level 3: Standard</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/workflows/level-4-brainstorm"><span title="Level 4: Brainstorm" class="linkLabel_PuAu">Level 4: Brainstorm</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/docs/workflows/level-5-intelligent"><span title="Level 5: Intelligent" class="linkLabel_PuAu">Level 5: Intelligent</span></a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/docs/faq"><span title="FAQ" class="linkLabel_PuAu">FAQ</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_namt"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><span class="breadcrumbs__link">Commands</span></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">CLI Commands</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">/cli:codex-review</span></li></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>/cli<!-- -->:codex-review</h1></header>
|
||
<p>Interactive code review command that invokes <code>codex review</code> via CCW CLI endpoint with guided parameter selection.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="overview">Overview<a href="#overview" class="hash-link" aria-label="Direct link to Overview" title="Direct link to Overview" translate="no"></a></h2>
|
||
<p>The <code>/cli:codex-review</code> command provides an interface to Codex's powerful code review capabilities, supporting multiple review targets and customizable review parameters.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="review-parameters">Review Parameters<a href="#review-parameters" class="hash-link" aria-label="Direct link to Review Parameters" title="Direct link to Review Parameters" translate="no"></a></h2>
|
||
<table><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>[PROMPT]</code></td><td>Custom review instructions (positional)</td></tr><tr><td><code>-c model=&lt;model&gt;</code></td><td>Override model via config</td></tr><tr><td><code>--uncommitted</code></td><td>Review staged, unstaged, and untracked changes</td></tr><tr><td><code>--base &lt;BRANCH&gt;</code></td><td>Review changes against base branch</td></tr><tr><td><code>--commit &lt;SHA&gt;</code></td><td>Review changes introduced by a commit</td></tr><tr><td><code>--title &lt;TITLE&gt;</code></td><td>Optional commit title for review summary</td></tr></tbody></table>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="usage">Usage<a href="#usage" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage" translate="no"></a></h2>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="direct-execution-no-interaction">Direct Execution (No Interaction)<a href="#direct-execution-no-interaction" class="hash-link" aria-label="Direct link to Direct Execution (No Interaction)" title="Direct link to Direct Execution (No Interaction)" translate="no"></a></h3>
|
||
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_kX1v"><pre tabindex="0" class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#bfc7d5"><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Review uncommitted changes</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">/cli:codex-review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--uncommitted</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Review against main branch</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">/cli:codex-review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--base</span><span class="token plain"> main</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Review specific commit</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">/cli:codex-review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--commit</span><span class="token plain"> abc123</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Review with custom model</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">/cli:codex-review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--uncommitted</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--model</span><span class="token plain"> o3</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Review with security focus</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">/cli:codex-review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--uncommitted</span><span class="token plain"> security</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Full options</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">/cli:codex-review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--base</span><span class="token plain"> main </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--model</span><span class="token plain"> o3 </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--title</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"Auth Feature"</span><span class="token plain"> security</span><br></span></code></pre></div></div>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="interactive-mode">Interactive Mode<a href="#interactive-mode" class="hash-link" aria-label="Direct link to Interactive Mode" title="Direct link to Interactive Mode" translate="no"></a></h3>
|
||
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_kX1v"><pre tabindex="0" class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#bfc7d5"><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Start interactive selection (guided flow)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">/cli:codex-review</span><br></span></code></pre></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="review-targets">Review Targets<a href="#review-targets" class="hash-link" aria-label="Direct link to Review Targets" title="Direct link to Review Targets" translate="no"></a></h2>
|
||
<table><thead><tr><th>Target</th><th>Description</th><th>Use Case</th></tr></thead><tbody><tr><td><strong>Uncommitted</strong></td><td>Reviews staged, unstaged, and untracked changes</td><td>Quick pre-commit review</td></tr><tr><td><strong>Base Branch</strong></td><td>Reviews changes against specified branch</td><td>PR review, branch comparison</td></tr><tr><td><strong>Commit</strong></td><td>Reviews changes introduced by specific commit</td><td>Historical commit review</td></tr></tbody></table>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="focus-areas">Focus Areas<a href="#focus-areas" class="hash-link" aria-label="Direct link to Focus Areas" title="Direct link to Focus Areas" translate="no"></a></h2>
|
||
<table><thead><tr><th>Focus</th><th>Description</th><th>Key Checks</th></tr></thead><tbody><tr><td><strong>General</strong></td><td>Comprehensive review</td><td>Correctness, style, bugs, documentation</td></tr><tr><td><strong>Security</strong></td><td>Security-first review</td><td>Injection vulnerabilities, auth issues, validation, data exposure</td></tr><tr><td><strong>Performance</strong></td><td>Optimization review</td><td>Complexity analysis, memory usage, query optimization, caching</td></tr><tr><td><strong>Code Quality</strong></td><td>Maintainability review</td><td>SOLID principles, code duplication, naming conventions, test coverage</td></tr></tbody></table>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="execution-flow">Execution Flow<a href="#execution-flow" class="hash-link" aria-label="Direct link to Execution Flow" title="Direct link to Execution Flow" translate="no"></a></h2>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="interactive-mode-1">Interactive Mode<a href="#interactive-mode-1" class="hash-link" aria-label="Direct link to Interactive Mode" title="Direct link to Interactive Mode" translate="no"></a></h3>
|
||
<ol>
|
||
<li class=""><strong>Select Review Target</strong> - Choose uncommitted, base branch, or commit</li>
|
||
<li class=""><strong>Select Focus Area</strong> - Choose general, security, performance, or code quality</li>
|
||
<li class=""><strong>Configure Options</strong> - Set model, title, and custom instructions</li>
|
||
<li class=""><strong>Execute Review</strong> - Runs Codex review with selected parameters</li>
|
||
<li class=""><strong>Display Results</strong> - Shows structured review findings</li>
|
||
</ol>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="command-construction">Command Construction<a href="#command-construction" class="hash-link" aria-label="Direct link to Command Construction" title="Direct link to Command Construction" translate="no"></a></h3>
|
||
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_kX1v"><pre tabindex="0" class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#bfc7d5"><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Base structure</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">ccw cli </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">-p</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"<PROMPT>"</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--tool</span><span class="token plain"> codex </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--mode</span><span class="token plain"> review </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">OPTIONS</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Example with custom prompt</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">ccw cli </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">-p</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token string" style="color:rgb(195, 232, 141)">PURPOSE: Comprehensive code review to identify issues and improve quality</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token string" style="color:rgb(195, 232, 141)">TASK: • Review correctness and logic • Check standards compliance • Identify bugs</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token string" style="color:rgb(195, 232, 141)">MODE: review</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token string" style="color:rgb(195, 232, 141)">CONTEXT: Reviewing uncommitted changes</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token string" style="color:rgb(195, 232, 141)">CONSTRAINTS: Actionable feedback</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token string" style="color:rgb(195, 232, 141)">"</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--tool</span><span class="token plain"> codex </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--mode</span><span class="token plain"> review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--rule</span><span class="token plain"> analysis-review-code-quality</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Example with target flag only</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">ccw cli </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--tool</span><span class="token plain"> codex </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--mode</span><span class="token plain"> review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--uncommitted</span><br></span></code></pre></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="prompt-template">Prompt Template<a href="#prompt-template" class="hash-link" aria-label="Direct link to Prompt Template" title="Direct link to Prompt Template" translate="no"></a></h2>
|
||
<p>Follow the standard CCW CLI prompt template:</p>
|
||
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_kX1v"><pre tabindex="0" class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#bfc7d5"><span class="token plain">PURPOSE: </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">what</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> + </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">why</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> + </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">success criteria</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">TASK: • </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">step </span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> • </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">step </span><span class="token number" style="color:rgb(247, 140, 108)">2</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> • </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">step </span><span class="token number" style="color:rgb(247, 140, 108)">3</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">MODE: review</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">CONTEXT: </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">target description</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> </span><span class="token operator" style="color:rgb(137, 221, 255)">|</span><span class="token plain"> Memory: </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">project context</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">EXPECTED: </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">deliverable format</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> + </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">quality criteria</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">CONSTRAINTS: </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">domain constraints</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><br></span></code></pre></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="validation-constraints">Validation Constraints<a href="#validation-constraints" class="hash-link" aria-label="Direct link to Validation Constraints" title="Direct link to Validation Constraints" translate="no"></a></h2>
|
||
<p><strong>IMPORTANT</strong>: Target flags (<code>--uncommitted</code>, <code>--base</code>, <code>--commit</code>) and custom prompt are <strong>mutually exclusive</strong>.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="valid-combinations">Valid Combinations<a href="#valid-combinations" class="hash-link" aria-label="Direct link to Valid Combinations" title="Direct link to Valid Combinations" translate="no"></a></h3>
|
||
<table><thead><tr><th>Command</th><th>Result</th></tr></thead><tbody><tr><td><code>codex review "Focus on security"</code></td><td>✓ Custom prompt, reviews uncommitted (default)</td></tr><tr><td><code>codex review --uncommitted</code></td><td>✓ No prompt, uses default review</td></tr><tr><td><code>codex review --base main</code></td><td>✓ No prompt, uses default review</td></tr><tr><td><code>codex review --commit abc123</code></td><td>✓ No prompt, uses default review</td></tr></tbody></table>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="invalid-combinations">Invalid Combinations<a href="#invalid-combinations" class="hash-link" aria-label="Direct link to Invalid Combinations" title="Direct link to Invalid Combinations" translate="no"></a></h3>
|
||
<table><thead><tr><th>Command</th><th>Result</th></tr></thead><tbody><tr><td><code>codex review --uncommitted "prompt"</code></td><td>✗ Mutually exclusive</td></tr><tr><td><code>codex review --base main "prompt"</code></td><td>✗ Mutually exclusive</td></tr><tr><td><code>codex review --commit abc123 "prompt"</code></td><td>✗ Mutually exclusive</td></tr></tbody></table>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="error-handling">Error Handling<a href="#error-handling" class="hash-link" aria-label="Direct link to Error Handling" title="Direct link to Error Handling" translate="no"></a></h2>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="no-changes-to-review">No Changes to Review<a href="#no-changes-to-review" class="hash-link" aria-label="Direct link to No Changes to Review" title="Direct link to No Changes to Review" translate="no"></a></h3>
|
||
<div class="language-text codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_kX1v"><pre tabindex="0" class="prism-code language-text codeBlock_TAPP thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#bfc7d5"><span class="token plain">No changes found for review target. Suggestions:</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">- For --uncommitted: Make some code changes first</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">- For --base: Ensure branch exists and has diverged</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">- For --commit: Verify commit SHA exists</span><br></span></code></pre></div></div>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="invalid-branch">Invalid Branch<a href="#invalid-branch" class="hash-link" aria-label="Direct link to Invalid Branch" title="Direct link to Invalid Branch" translate="no"></a></h3>
|
||
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_kX1v"><pre tabindex="0" class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#bfc7d5"><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Show available branches</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> branch </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">-a</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--list</span><span class="token plain"> </span><span class="token operator" style="color:rgb(137, 221, 255)">|</span><span class="token plain"> </span><span class="token function" style="color:rgb(130, 170, 255)">head</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">-20</span><br></span></code></pre></div></div>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="invalid-commit">Invalid Commit<a href="#invalid-commit" class="hash-link" aria-label="Direct link to Invalid Commit" title="Direct link to Invalid Commit" translate="no"></a></h3>
|
||
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_kX1v"><pre tabindex="0" class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#bfc7d5"><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Show recent commits</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token function" style="color:rgb(130, 170, 255)">git</span><span class="token plain"> log </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--oneline</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">-10</span><br></span></code></pre></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="examples">Examples<a href="#examples" class="hash-link" aria-label="Direct link to Examples" title="Direct link to Examples" translate="no"></a></h2>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="pre-commit-review">Pre-Commit Review<a href="#pre-commit-review" class="hash-link" aria-label="Direct link to Pre-Commit Review" title="Direct link to Pre-Commit Review" translate="no"></a></h3>
|
||
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_kX1v"><pre tabindex="0" class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#bfc7d5"><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Quick review before committing</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">/cli:codex-review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--uncommitted</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Output:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Reviewing 3 files with 45 changes</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># - src/auth/login.ts: 2 issues found</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># - src/user/profile.ts: 1 issue found</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># - tests/auth.test.ts: No issues</span><br></span></code></pre></div></div>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="branch-comparison">Branch Comparison<a href="#branch-comparison" class="hash-link" aria-label="Direct link to Branch Comparison" title="Direct link to Branch Comparison" translate="no"></a></h3>
|
||
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_kX1v"><pre tabindex="0" class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#bfc7d5"><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Review feature branch against main</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">/cli:codex-review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--base</span><span class="token plain"> feature-auth</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Shows all differences between branches</span><br></span></code></pre></div></div>
|
||
<h3 class="anchor anchorTargetStickyNavbar_SAay" id="security-focused-review">Security-Focused Review<a href="#security-focused-review" class="hash-link" aria-label="Direct link to Security-Focused Review" title="Direct link to Security-Focused Review" translate="no"></a></h3>
|
||
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_kX1v"><pre tabindex="0" class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_AdAo"><span class="token-line" style="color:#bfc7d5"><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Security review of uncommitted changes</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">/cli:codex-review </span><span class="token parameter variable" style="color:rgb(191, 199, 213)">--uncommitted</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"Focus on security vulnerabilities, injection risks, authentication issues"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Prioritizes security-related findings</span><br></span></code></pre></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="related-commands">Related Commands<a href="#related-commands" class="hash-link" aria-label="Direct link to Related Commands" title="Direct link to Related Commands" translate="no"></a></h2>
|
||
<ul>
|
||
<li class=""><strong>/cli<!-- -->:cli-init</strong> - Initialize CLI configuration</li>
|
||
<li class=""><strong>/workflow<!-- -->:review-session-cycle</strong> - Session-based code review</li>
|
||
<li class=""><strong>/workflow<!-- -->:review-module-cycle</strong> - Module-specific code review</li>
|
||
</ul>
|
||
<h2 class="anchor anchorTargetStickyNavbar_SAay" id="integration-notes">Integration Notes<a href="#integration-notes" class="hash-link" aria-label="Direct link to Integration Notes" title="Direct link to Integration Notes" translate="no"></a></h2>
|
||
<ul>
|
||
<li class="">Uses <code>ccw cli --tool codex --mode review</code> endpoint</li>
|
||
<li class="">Model passed via prompt (codex uses <code>-c model=</code> internally)</li>
|
||
<li class="">Target flags passed through to codex</li>
|
||
<li class="">Prompt follows standard CCW CLI template format</li>
|
||
<li class="">Results include severity levels, file<!-- -->:line<!-- --> references, and remediation suggestions</li>
|
||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_HJkF"><a href="https://github.com/ccw/docs/tree/main/docs/commands/cli/codex-review.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_g62E"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/docs/commands/cli/cli-init"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">/cli:cli-init</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/docs/commands/memory/memory-update-full"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">/memory:update-full</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#review-parameters" class="table-of-contents__link toc-highlight">Review Parameters</a></li><li><a href="#usage" class="table-of-contents__link toc-highlight">Usage</a><ul><li><a href="#direct-execution-no-interaction" class="table-of-contents__link toc-highlight">Direct Execution (No Interaction)</a></li><li><a href="#interactive-mode" class="table-of-contents__link toc-highlight">Interactive Mode</a></li></ul></li><li><a href="#review-targets" class="table-of-contents__link toc-highlight">Review Targets</a></li><li><a href="#focus-areas" class="table-of-contents__link toc-highlight">Focus Areas</a></li><li><a href="#execution-flow" class="table-of-contents__link toc-highlight">Execution Flow</a><ul><li><a href="#interactive-mode-1" class="table-of-contents__link toc-highlight">Interactive Mode</a></li><li><a href="#command-construction" class="table-of-contents__link toc-highlight">Command Construction</a></li></ul></li><li><a href="#prompt-template" class="table-of-contents__link toc-highlight">Prompt Template</a></li><li><a href="#validation-constraints" class="table-of-contents__link toc-highlight">Validation Constraints</a><ul><li><a href="#valid-combinations" class="table-of-contents__link toc-highlight">Valid Combinations</a></li><li><a href="#invalid-combinations" class="table-of-contents__link toc-highlight">Invalid Combinations</a></li></ul></li><li><a href="#error-handling" class="table-of-contents__link toc-highlight">Error Handling</a><ul><li><a href="#no-changes-to-review" class="table-of-contents__link toc-highlight">No Changes to Review</a></li><li><a href="#invalid-branch" class="table-of-contents__link toc-highlight">Invalid Branch</a></li><li><a href="#invalid-commit" class="table-of-contents__link toc-highlight">Invalid Commit</a></li></ul></li><li><a href="#examples" class="table-of-contents__link toc-highlight">Examples</a><ul><li><a href="#pre-commit-review" class="table-of-contents__link toc-highlight">Pre-Commit Review</a></li><li><a href="#branch-comparison" class="table-of-contents__link toc-highlight">Branch Comparison</a></li><li><a href="#security-focused-review" class="table-of-contents__link toc-highlight">Security-Focused Review</a></li></ul></li><li><a href="#related-commands" class="table-of-contents__link toc-highlight">Related Commands</a></li><li><a href="#integration-notes" class="table-of-contents__link toc-highlight">Integration Notes</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 CCW. Built with Docusaurus.</div></div></div></footer></div>
|
||
</body>
|
||
</html> |