How to Use Codex Cloud: From GitHub Setup to Your First Pull Request

Codex Cloud allows you to delegate coding tasks to an agent operating in a remote environment. This environment can read the project, modify files, execute commands, and compile changes for review on GitHub. To begin, start with a small JavaScript example. First, ask Codex to explain the project to gain the necessary context before proceeding with a specific fix. The video walkthrough is available at https://youtu.be/GPrPPNCu1Uw?embedable=true.

Setting up the environment involves connecting your GitHub project, selecting the project, and initiating the process. Codex prepares the project, produces a setup report, and saves the environment. Review this report to ensure compatibility with your project's requirements, checking runtime versions, commands, and any necessary setup adjustments.

After publishing the environment, you can start a task. Begin by describing the project to Codex, which will then provide an explanation of the repository's structure, main files, and how the project operates. Request a focused fix for any identified issues, specifying the expected behavior and any tests you want to be implemented. Ensure your requests are precise and avoid making unrelated changes or introducing new dependencies.

Once the changes are made, ask Codex for the diff of the changes and test the new implementation using the project's documentation. For Node.js projects, this might involve running a test command like `node search.test.js`. Verify that the test inputs and outputs match the expected results. If any tests fail, provide Codex with the exact command, input, expected result, and actual result for further analysis.

For interface changes, open the application in a local or preview environment to ensure compatibility with the updated setup.

Finally, create a pull request on GitHub to share the proposed changes for review. The cloud environment and GitHub maintain separate states, so the proposed changes will be reviewed independently. Open the provided link on GitHub to review the source and target branches, the diff of the changes, and any additional details provided.