Commit Graph

90 Commits

  • feat: notify when a newer version is available (#333)
    **Summary**  
    This change introduces a new startup check that notifies users if a
    newer `@openai/codex` version is available. To avoid spamming, it writes
    a small state file recording the last check time and will only re‑check
    once every 24 hours.
    
    **What’s Changed**  
    - **New file** `src/utils/check-updates.ts`  
      - Runs `npm outdated --global @openai/codex`  
      - Reads/writes `codex-state.json` under `CONFIG_DIR`  
      - Limits checks to once per day (`UPDATE_CHECK_FREQUENCY = 24h`)  
    - Uses `boxen` for a styled alert and `which` to locate the npm binary
    - **Hooked into** `src/cli.tsx` entrypoint:
      ```ts
      import { checkForUpdates } from "./utils/check-updates";
      // …
      // after loading config
      await checkForUpdates().catch();
      ```
    - **Dependencies**  
      - Added `boxen@^8.0.1`, `which@^5.0.0`, `@types/which@^3.0.4`  
    - **Tests**  
      - Vitest suite under `tests/check-updates.test.ts`  
      - Snapshot in `__snapshots__/check-updates.test.ts.snap`  
    
    **Motivation**  
    Addresses issue #244. Users running a stale global install will now see
    a friendly reminder—at most once per day—to upgrade and enjoy the latest
    features.
    
    **Test Plan**  
    - `getNPMCommandPath()` resolves npm correctly  
    - `checkOutdated()` parses `npm outdated` JSON  
    - State file prevents repeat alerts within 24h  
    - Boxen snapshot matches expected output  
    - No console output when state indicates a recent check  
    
    **Related Issue**  
    try resolves #244
    
    
    **Preview**
    Prompt a pnpm‑style alert when outdated  
    
    ![outdated‑alert](https://github.com/user-attachments/assets/294dad45-d858-45d1-bf34-55e672ab883a)
    
    Let me know if you’d tweak any of the messaging, throttle frequency,
    placement in the startup flow, or anything else.
    
    ---------
    
    Co-authored-by: Thibault Sottiaux <tibo@openai.com>
  • chore: migrate to pnpm for improved monorepo management (#287)
    # Migrate to pnpm for improved monorepo management
    
    ## Summary
    This PR migrates the Codex repository from npm to pnpm, providing faster
    dependency installation, better disk space usage, and improved monorepo
    management.
    
    ## Changes
    - Added `pnpm-workspace.yaml` to define workspace packages
    - Added `.npmrc` with optimal pnpm configuration
    - Updated root package.json with workspace scripts
    - Moved resolutions and overrides to the root package.json
    - Updated scripts to use pnpm instead of npm
    - Added documentation for the migration
    - Updated GitHub Actions workflow for pnpm
    
    ## Benefits
    - **Faster installations**: pnpm is significantly faster than npm
    - **Disk space savings**: pnpm's content-addressable store avoids
    duplication
    - **Strict dependency management**: prevents phantom dependencies
    - **Simplified monorepo management**: better workspace coordination
    - **Preparation for Turborepo**: as discussed, this is the first step
    before adding Turborepo
    
    ## Testing
    - Verified that `pnpm install` works correctly
    - Verified that `pnpm run build` completes successfully
    - Ensured all existing functionality is preserved
    
    ## Documentation
    Added a detailed migration guide in `PNPM_MIGRATION.md` explaining:
    - Why we're migrating to pnpm
    - How to use pnpm with this repository
    - Common commands and workspace-specific commands
    - Monorepo structure and configuration
    
    ## Next Steps
    As discussed, once this change is stable, we can consider adding
    Turborepo as a follow-up enhancement.
  • feat: add /bug report command (#312)
    Add `/bug` command for chat session
  • bump(version): 0.1.2504172351 (#310)
    Release `@openai/codex@0.1.2504172351`
  • add: changelog (#308)
    - Release `@openai/codex@0.1.2504172304`
    - Add changelog
  • fix: canonicalize the writeable paths used in seatbelt policy (#275)
    closes #207
    
    I'd be lying if I said I was familiar with these particulars more than a
    couple hours ago, but after investigating and testing locally, this does
    fix the go issue, I prefer it over #272 which is a lot of code and a one
    off fix
    ---- 
    
    cc @bolinfest do you mind taking a look here?
    
    1. Seatbelt compares the paths it gets from the kernal to its policies
    1. Go is attempting to write to the os.tmpdir, which we have
    allowlisted.
    1. The kernel rewrites /var/… to /private/var/… before the sandbox
    check.
    1. The policy still said /var/…, so writes were denied.
    
    Fix: canonicalise every writable root we feed into the policy
    (realpathSync(...)).
    We do not have to touch runtime file paths—the kernel already
    canonicalises those.
    
    
    
    ### before
    see that the command exited 1, and that the command was reported to be
    prohibited, despite using the allowlisted tmpdir
    
    
    https://github.com/user-attachments/assets/23911101-0ec0-4a59-a0a1-423be04063f0
    
    
    ### after
    command exits 0
    
    
    https://github.com/user-attachments/assets/6ab2bcd6-68bd-4f89-82bb-2c8612e39ac3
  • feat: add /compact (#289)
    Added the ability to compact. Not sure if I should switch the model over
    to gpt-4.1 for longer context or if keeping the current model is fine.
    Also I'm not sure if setting the compacted to system is best practice,
    would love feedback 😄
    
    Mentioned in this issue: https://github.com/openai/codex/issues/230
  • bump(version): 0.1.2504161551 (#254)
    Bump version
    
    ---------
    
    Signed-off-by: Fouad Matin <fouad@openai.com>
    Co-authored-by: Jon Church <me@jonchurch.com>
  • chore: consolidate patch prefix constants in apply‑patch.ts (#274)
    This PR replaces all hard‑coded patch markers in apply‑patch.ts with the
    corresponding constants (now) exported from parse‑apply‑patch.ts.
    
    Changes
    • Import PATCH_PREFIX, PATCH_SUFFIX, ADD_FILE_PREFIX,
    DELETE_FILE_PREFIX, UPDATE_FILE_PREFIX, MOVE_FILE_TO_PREFIX,
    END_OF_FILE_PREFIX, and HUNK_ADD_LINE_PREFIX from parse‑apply‑patch.ts.
    	•	Remove duplicate string literals for patch markers in apply‑patch.ts.
    • Changed is_done() to trim the input to account for the slight
    difference between the variables.
    
    Why
    • DRY & Consistency: Ensures a single source of truth for patch
    prefixes.
    • Maintainability: Simplifies future updates to prefix values by
    centralizing them.
    	•	Readability: Makes the code more declarative and self‑documenting.
    
    All tests are passing, lint and format was ran.
  • feat: add notifications for MacOS using Applescript (#160)
    yolo'ed it with codex. Let me know if this looks good to you.
    
    https://github.com/openai/codex/issues/148
    
    tested with:
    ```
    npm run build:dev
    ```
    
    <img width="377" alt="Screenshot 2025-04-16 at 18 12 01"
    src="https://github.com/user-attachments/assets/79aa799b-b0b9-479d-84f1-bfb83d34bfb9"
    />
  • add support for -w,--writable-root to add more writable roots for sandbox (#263)
    This adds support for a new flag, `-w,--writable-root`, that can be
    specified multiple times to _amend_ the list of folders that should be
    configured as "writable roots" by the sandbox used in `full-auto` mode.
    Values that are passed as relative paths will be resolved to absolute
    paths.
    
    Incidentally, this required updating a number of the `agent*.test.ts`
    files: it feels like some of the setup logic across those tests could be
    consolidated.
    
    In my testing, it seems that this might be slightly out of distribution
    for the model, as I had to explicitly tell it to run `apply_patch` and
    that it had the permissions to write those files (initially, it just
    showed me a diff and told me to apply it myself). Nevertheless, I think
    this is a good starting point.
  • feat: shell command explanation option (#173)
    # Shell Command Explanation Option
    
    ## Description
    This PR adds an option to explain shell commands when the user is
    prompted to approve them (Fixes #110). When reviewing a shell command,
    users can now select "Explain this command" to get a detailed
    explanation of what the command does before deciding whether to approve
    or reject it.
    
    ## Changes
    - Added a new "EXPLAIN" option to the `ReviewDecision` enum
    - Updated the command review UI to include an "Explain this command (x)"
    option
    - Implemented the logic to send the command to the LLM for explanation
    using the same model as the agent
    - Added a display for the explanation in the command review UI
    - Updated all relevant components to pass the explanation through the
    component tree
    
    ## Benefits
    - Improves user understanding of shell commands before approving them
    - Reduces the risk of approving potentially harmful commands
    - Enhances the educational aspect of the tool, helping users learn about
    shell commands
    - Maintains the same workflow with minimal UI changes
    
    ## Testing
    - Manually tested the explanation feature with various shell commands
    - Verified that the explanation is displayed correctly in the UI
    - Confirmed that the user can still approve or reject the command after
    viewing the explanation
    
    ## Screenshots
    
    ![improved_shell_explanation_demo](https://github.com/user-attachments/assets/05923481-29db-4eba-9cc6-5e92301d2be0)
    
    
    ## Additional Notes
    The explanation is generated using the same model as the agent, ensuring
    consistency in the quality and style of explanations.
    
    ---------
    
    Signed-off-by: crazywolf132 <crazywolf132@gmail.com>
  • fix: update regex to better match the retry error messages (#266)
    I think the retry issue is just that the regex is wrong, checkout the
    reported error messages folks are seeing:
    
    > message: 'Rate limit reached for o4-mini in organization
    org-{redacted} on tokens per min (TPM): Limit 200000, Used 152566,
    Requested 60651. Please try again in 3.965s. Visit
    https://platform.openai.com/account/rate-limits to learn more.',
    
    The error message uses `try again` not `retry again`
    
    peep this regexpal: https://www.regexpal.com/?fam=155648
  • feat: add command history persistence (#152)
    This PR adds a command history persistence feature to Codex CLI that:
    
    1. **Stores command history**: Commands are saved to
    `~/.codex/history.json` and persist between CLI sessions.
    2. **Navigates history**: Users can use the up/down arrow keys to
    navigate through command history, similar to a traditional shell.
    3. **Filters sensitive data**: Built-in regex patterns prevent commands
    containing API keys, passwords, or tokens from being saved.
    4. **Configurable**: Added configuration options for history size,
    enabling/disabling history, and custom regex patterns for sensitive
    content.
    5. **New command**: Added `/clearhistory` command to clear command
    history.
    
      ## Code Changes
    
    - Added `src/utils/storage/command-history.ts` with functions for
    history management
      - Extended config system to support history settings
      - Updated terminal input components to use persistent history
      - Added help text for the new `/clearhistory` command
      - Added CLAUDE.md file for guidance when working with the codebase
    
      ## Testing
    
      - All tests are passing
    - Core functionality works with both input components (standard and
    multiline)
    - History navigation behaves correctly at line boundaries with the
    multiline editor
  • fix: improve Windows compatibility for CLI commands and sandbox (#261)
    ## Fix Windows compatibility issues (#248)
    
    This PR addresses the Windows compatibility issues reported in #248:
    
    1. **Fix sandbox initialization failure on Windows**
    - Modified `getSandbox()` to return `SandboxType.NONE` on Windows
    instead of throwing an error
    - Added a warning log message to inform the user that sandbox is not
    available on Windows
    
    2. **Fix Unix commands not working on Windows**
    - Created a new module
    [platform-commands.ts](cci:7://file:///c:/Users/HP%20840%20G6/workflow/codex/codex-cli/src/utils/agent/platform-commands.ts:0:0-0:0)
    that automatically adapts Unix commands to their Windows equivalents
       - Implemented a mapping table for common commands and their options
       - Integrated this functionality into the command execution process
    
    ### Testing
    Tested on Windows 10 with the following commands:
    - `ls -R .` (now automatically translates to `dir /s .`)
    - Other Unix commands like `grep`, `cat`, etc.
    
    The CLI no longer crashes when running these commands on Windows.
    
    I have read the CLA Document and I hereby sign the CLA
    
    ---------
    
    Signed-off-by: Alpha Diop <alphakhoss@gmail.com>
  • docs: clarify sandboxing situation on Linux (#103)
    There doesn't appear to actually be any sandboxing on Linux. Correct the
    README.
    
    Signed-off-by: Christopher Cooper <christopher@cg505.com>
  • bugfix: additional error handling logic for model errors that occur in stream (#203)
    **What is  added?**
    
    Additional error handling functionality is added before the errors are
    thrown to be handled by upstream handlers. The changes improves the user
    experience and make the error handling smoother (and more informative).
    
    **Why is it added?**
    Before this addition, when a user tried to use a model they needed
    previous setup for, the program crashed. This is not necessary here, and
    informative message is sufficient and enhances user experience. This
    adheres to the specifications stated in the code file as well by not
    masking potential logical error detection. Following is before and
    after:
    
    
    ![first](https://github.com/user-attachments/assets/0ce7c57d-8159-4cf7-8a53-3062cfd04dc8)
    
    ![second](https://github.com/user-attachments/assets/a9f24410-d76d-43d4-a0e2-ec513026843d)
    
    Moreover, AFAIK no logic was present to handle this or a similar issue
    in upstream handlers.
    
    **How is it scoped? Why won't this mask other errors?**
    The new brach triggers *only* for `invalid_request_error` events whose
    `code` is model related (`model_not_found`)
    
    This also doesn't prevent the detection (for the case of masking logical
    errors) of wrong model names, as they would have been caught earlier on.
    
    The code passes test, lint and type checks. I believe relevant
    documentation is added, but I would be more than happy to do further
    fixes in the code if necessary.
  • fix: check workdir before spawn (#221)
    The workdir used to spawn a agent command is provide by the agent tool,
    we need to ensure its existence and fallback to process.cwd when not.
    
    fix #212
  • fix: typos in prompts and comments (#195)
    Used Codex and https://github.com/crate-ci/typos to identify + fix typos
    
    Signed-off-by: Jatan Loya <jatanloya@gmail.com>
  • fix: allow continuing after interrupting assistant (#178)
    ## Description
    This PR fixes the issue where the CLI can't continue after interrupting
    the assistant with ESC ESC (Fixes #114). The problem was caused by
    duplicate code in the `cancel()` method and improper state reset after
    cancellation.
    
    ## Changes
    - Fixed duplicate code in the `cancel()` method of the `AgentLoop` class
    - Added proper reset of the `currentStream` property in the `cancel()`
    method
    - Created a new `AbortController` after aborting the current one to
    ensure future tool calls work
    - Added a system message to indicate the interruption to the user
    - Added a comprehensive test to verify the fix
    
    ## Benefits
    - Users can now continue using the CLI after interrupting the assistant
    - Improved user experience by providing feedback when interruption
    occurs
    - Better state management in the agent loop
    
    ## Testing
    - Added a dedicated test that verifies the agent can process new input
    after cancellation
    - Manually tested the fix by interrupting the assistant and confirming
    that new input is processed correctly
    
    ---------
    
    Signed-off-by: crazywolf132 <crazywolf132@gmail.com>
  • fix: add missing "as" in prompt prefix in agent loop (#186)
    # Description
    
    This PR fixes a typo where the prompt prefix for the agent loop was
    missing the word "as"
    
    # Changes
    
    * Added missing word "as" within the agent loop prompt prefix
    
    # Benefits
    
    * The prompt is now grammatically correct and clearer
    
    # Testing
    
    * Manually tested the fix
  • (feat) expontential back-off when encountering rate limit errors (#153)
    ...and try to parse the suggested time from the error message while we
    don't yet have this in a structured way
    
    ---------
    
    Signed-off-by: Thibault Sottiaux <tibo@openai.com>
  • refactor: improve performance of renderFilesToXml using Array.join (#127)
    ### Summary
    
    Refactored the `renderFilesToXml` function to improve performance and
    readability by replacing iterative string concatenation with
    `Array.map().join()`.
    
    ### Changes
    
    - Replaced the `for...of` loop with `files.map(...).join('')`
    - Reduced number of string mutation operations
    - Preserved the existing XML structure and CDATA safety
    
    ### Why
    
    Using `join` avoids repeated string concatenation in loops, which can
    improve performance, especially when rendering a large number of files.
    It also results in more concise and idiomatic code.
    
    
    I have read the CLA Document and I hereby sign the CLA
    ---
    
    Let me know if this needs any adjustments!
    
    Signed-off-by: yonatanlavy <yehonatanmind@gmail.com>
  • Removes computeAutoApproval() and tightens up canAutoApprove() as the source of truth (#126)
    Previously, `parseToolCall()` was using `computeAutoApproval()`, which
    was a somewhat parallel implementation of `canAutoApprove()` in order to
    get `SafeCommandReason` metadata for presenting information to the user.
    The only function that was using `SafeCommandReason` was
    `useMessageGrouping()`, but it turns out that function was unused, so
    this PR removes `computeAutoApproval()` and all code related to it.
    
    More importantly, I believe this fixes
    https://github.com/openai/codex/issues/87 because
    `computeAutoApproval()` was calling `parse()` from `shell-quote` without
    wrapping it in a try-catch. This PR updates `canAutoApprove()` to use a
    tighter try-catch block that is specific to `parse()` and returns an
    appropriate `SafetyAssessment` in the event of an error, based on the
    `ApprovalPolicy`.
    
    Signed-off-by: Michael Bolin <mbolin@openai.com>
  • (feat) basic retries when hitting rate limit errors (#105)
    * w
    
    Signed-off-by: Thibault Sottiaux <tibo@openai.com>
    
    * w
    
    Signed-off-by: Thibault Sottiaux <tibo@openai.com>
    
    * w
    
    Signed-off-by: Thibault Sottiaux <tibo@openai.com>
    
    * w
    
    Signed-off-by: Thibault Sottiaux <tibo@openai.com>
    
    * w
    
    Signed-off-by: Thibault Sottiaux <tibo@openai.com>
    
    ---------
    
    Signed-off-by: Thibault Sottiaux <tibo@openai.com>
  • add: release script (#96)
    * add: release script
    
    * add: src to npm module
    
    * fix: readme
    
    Signed-off-by: Fouad Matin <fouad@openai.com>
    
    ---------
    
    Signed-off-by: Fouad Matin <fouad@openai.com>
  • fix: prompt typo (#81)
    * fix: developer typo
    
    * fix: typo
  • (feat) gracefully handle invalid commands (#79)
    * handle invalid commands
    * better test
    * format
  • remove rg requirement (#50)
    Signed-off-by: Thibault Sottiaux <tibo@openai.com>
  • (fix) o3 instead of o3-mini (#37)
    * o3 instead of o3-mini
  • Initial commit
    Signed-off-by: Ilan Bigio <ilan@openai.com>
  • Initial commit
    Signed-off-by: Ilan Bigio <ilan@openai.com>