Commit Graph

75 Commits

Author SHA1 Message Date
Christopher Cooper
f9c15523e7 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>
2025-04-17 08:15:39 -07:00
Alpha Diop
639c67b909 Feat/add husky (#223)
# Add Husky and lint-staged for automated code quality checks

## Description
This PR adds Husky Git hooks and lint-staged to automate code quality
checks during the development workflow.

## Features Added
- Pre-commit hook that runs lint-staged to check files before committing
- Pre-push hook that runs tests and type checking before pushing
- Configuration for lint-staged to format and lint different file types
- Documentation explaining the Husky setup and usage
- Updated README.md with information about Git hooks

## Benefits
- Ensures consistent code style across the project
- Prevents pushing code with failing tests or type errors
- Reduces the need for style-related code review comments
- Improves overall code quality

## Implementation Details
- Added Husky and lint-staged as dev dependencies
- Created pre-commit and pre-push hooks
- Added configuration for lint-staged
- Added documentation in HUSKY.md
- Updated README.md with a new section on Git hooks

## Testing
The hooks have been tested locally and work as expected:
- Pre-commit hook runs ESLint and Prettier on staged files
- Pre-push hook runs tests and type checking

I have read the CLA Document and I hereby sign the CLA

---------

Signed-off-by: Alpha Diop <alphakhoss@gmail.com>
2025-04-17 07:18:43 -07:00
Akshey D
842de865cd docs: add ZDR org limitation to README (#234)
**What?**
Add a section to the README documenting the current limitation for Codex
with Zero Data Retention (ZDR) organizations.

**Why?**
Users from ZDR organizations encounter errors due to the Responses API’s
requirement for `store:true`, which is incompatible with ZDR policies.
See #106 for more info.

**How?**
- Added a new section in the README, after FAQ and before Funding. 
- Explained the error message and reason.
- Linked to documentation as linked in the issue.
2025-04-17 07:09:23 -07:00
Thibault Sottiaux
4da38e7f01 (fix) move funding section before contrib section (#184)
Signed-off-by: Thibault Sottiaux <tibo@openai.com>
2025-04-16 21:01:03 -07:00
Mert Erbak
057f113c6d document Codex open source fund (#162)
I added a section about the Codex Open Source Fund to the README to
reach more developers.
2025-04-16 18:34:55 -07:00
Thibault Sottiaux
2aa8ae4167 fmt (#161)
Signed-off-by: Thibault Sottiaux <tibo@openai.com>
2025-04-16 18:15:22 -07:00
Thibault Sottiaux
9172840647 w
Signed-off-by: Thibault Sottiaux <tibo@openai.com>
2025-04-16 18:10:47 -07:00
Mehmet Vecdi Gönül
b8aea2340d minor change in description of Build from source in README.md (#149)
Separated the `node ./dist/cli.js --help ` and `node ./dist/cli.js `.
The comment suggested `node ./dist/cli.js --help ` was to run the
locally-built CLI but in fact it shows the usage an options. It is a
minor change and clarifies the flow for new developers.
2025-04-16 17:07:44 -07:00
Ashwin Ramaswami
099224e313 Fix markdown table in README (#144)
Before:

<img width="909" alt="image"
src="https://github.com/user-attachments/assets/8de0d798-5587-407a-9196-bda3e26c1331"
/>

After:

<img width="945" alt="image"
src="https://github.com/user-attachments/assets/90454694-2f26-49b1-8c4b-e017237797ca"
/>
2025-04-16 17:01:45 -07:00
Tomas Cupr
33d0d73b82 feat: add shell completion subcommand (#138)
Why
---
Improves the usability of the `codex` CLI by adding shell completion for
file paths. This allows users to quickly complete file arguments using
tab completion in bash, zsh, and fish shells. Enable via `eval "$(codex
completion <shell>)"`.
2025-04-16 16:34:44 -07:00
rohanoai
a39396d5c9 Adds link to prompting guide in README (#141) 2025-04-16 16:24:52 -07:00
Ilan Bigio
72d0230b33 Change bash to shell in README (#132) 2025-04-16 15:33:42 -07:00
Ilan Bigio
50925c0d6c Set up CLA process and remove DCO (#129)
Signed-off-by: Ilan Bigio <ilan@openai.com>
2025-04-16 15:24:31 -07:00
Isaac
cdd8b67dcd docs: add FAQ clarifying relation to OpenAI Codex (2021) (#91)
Signed-off-by: Isaac Gemal <isaacgemal@gmail.com>
2025-04-16 13:21:40 -07:00
Fouad Matin
3cd31c8e13 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>
2025-04-16 13:21:22 -07:00
Abhinav Das
e8afebac15 changing some readme text to make it more exact (#77)
Making README more factually and grammatically exact.
2025-04-16 12:44:03 -07:00
Misha Davidov
a5641a0d9c [readme] security review recipe (#72)
* [readme] security review recipe
2025-04-16 12:12:44 -07:00
Samin Amanat
24e86da575 Update README.md (#46)
Fix a typo where a p should have been a q
2025-04-16 11:42:46 -07:00
Thibault Sottiaux
e323b2cc95 remove rg requirement (#50)
Signed-off-by: Thibault Sottiaux <tibo@openai.com>
2025-04-16 11:37:16 -07:00
Hugo
b84075aa64 add explanation on how to add OPENAI_API_KEY to docs (#28)
Signed-off-by: Hugo Biais <hugobiais75@gmail.com>
2025-04-16 11:24:35 -07:00
oai-ragona
501e96f3d5 [readme] Add recipe for code review (#40)
One of my favorite use cases is a read-only one; have `codex` suggest areas of the codebase that need attention. From here, it's also easy for the user to select one of the proposed tasks and have `codex` make the PR.
2025-04-16 11:19:58 -07:00
Arash Ari Sheyda
26d551e303 chore(readme): fix typos (#27) 2025-04-16 11:03:52 -07:00
ddgond
704df1efa3 Update README.md to include correct default (#12) 2025-04-16 10:45:24 -07:00
Thibault Sottiaux
4ad39fc4e1 remove triaging labels section + avoid capturing exitOnCtrlC for full-context mode
Signed-off-by: Thibault Sottiaux <tibo@openai.com>
2025-04-16 10:41:44 -07:00
Ilan Bigio
59a180ddec Initial commit
Signed-off-by: Ilan Bigio <ilan@openai.com>
2025-04-16 12:56:08 -04:00