Skip to content

Commit cd7835d

Browse files
committed
updated readme
1 parent 78f8754 commit cd7835d

1 file changed

Lines changed: 26 additions & 12 deletions

File tree

README.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,26 @@
1-
# Codex Open
1+
# OpenCodex
22

3-
Codex Open is a local-first build of the Codex CLI focused on open model
4-
provider support. It keeps the familiar terminal coding-agent workflow while
5-
adding provider integrations that can be used without changing a global Codex
6-
installation.
3+
OpenCodex is a local-first, community-driven build of the Codex CLI focused on
4+
open model provider support. It keeps the familiar terminal coding-agent
5+
workflow while adding provider integrations that can be used without changing a
6+
global Codex installation.
77

8-
The first release feature is native NVIDIA NIM support.
8+
The first release feature is native NVIDIA NIM support. More providers and
9+
quality-of-life features will be added from real community requests.
10+
11+
## Community
12+
13+
OpenCodex is meant to be practical and community-shaped. If something breaks,
14+
open an issue. If a provider, model, or workflow is missing, open a feature
15+
request. If the request is clear, useful, and backed by official docs where
16+
needed, it can be added.
17+
18+
Bring the details that make the work actionable:
19+
20+
- What you tried.
21+
- What failed or what you want added.
22+
- Provider/model docs when the request involves an external API.
23+
- Exact model ids, endpoints, and error messages when available.
924

1025
## Highlights
1126

@@ -18,9 +33,8 @@ The first release feature is native NVIDIA NIM support.
1833
- Provider-specific shell guidance to prefer fast workspace search tools such as
1934
`rg`, `rg --files`, and `git ls-files`.
2035

21-
Future provider and feature integrations will be considered through GitHub
22-
issues. Open a provider request when you want another model host or API surface
23-
added.
36+
Future provider and feature integrations will be driven through GitHub issues.
37+
Open a provider request when you want another model host or API surface added.
2438

2539
## Quick Start
2640

@@ -61,7 +75,7 @@ for example `z-ai/glm-5.1`.
6175

6276
## NVIDIA NIM
6377

64-
Codex Open uses NVIDIA NIM's OpenAI-compatible API shape:
78+
OpenCodex uses NVIDIA NIM's OpenAI-compatible API shape:
6579

6680
- Model catalog: `GET /v1/models`
6781
- Chat inference: `POST /v1/chat/completions`
@@ -86,7 +100,7 @@ Detailed setup and troubleshooting are in
86100

87101
This release is provider-focused. NVIDIA NIM is the first supported external
88102
provider. Additional providers, model controls, and provider-specific features
89-
will be added based on real user requests and tested integrations.
103+
will be added based on community requests and tested integrations.
90104

91105
See [`RELEASE_NOTES.md`](RELEASE_NOTES.md) for the current release notes.
92106

@@ -129,5 +143,5 @@ space.
129143
## License
130144

131145
This repository is licensed under the [Apache-2.0 License](LICENSE). Codex is an
132-
open source project originally released by OpenAI; this build adds community
146+
open source project originally released by OpenAI; OpenCodex adds community
133147
provider integration work on top of that codebase.

0 commit comments

Comments
 (0)