feat: initial import of Rust implementation of Codex CLI in codex-rs/ (#629)
As stated in `codex-rs/README.md`:
Today, Codex CLI is written in TypeScript and requires Node.js 22+ to
run it. For a number of users, this runtime requirement inhibits
adoption: they would be better served by a standalone executable. As
maintainers, we want Codex to run efficiently in a wide range of
environments with minimal overhead. We also want to take advantage of
operating system-specific APIs to provide better sandboxing, where
possible.
To that end, we are moving forward with a Rust implementation of Codex
CLI contained in this folder, which has the following benefits:
- The CLI compiles to small, standalone, platform-specific binaries.
- Can make direct, native calls to
[seccomp](https://man7.org/linux/man-pages/man2/seccomp.2.html) and
[landlock](https://man7.org/linux/man-pages/man7/landlock.7.html) in
order to support sandboxing on Linux.
- No runtime garbage collection, resulting in lower memory consumption
and better, more predictable performance.
Currently, the Rust implementation is materially behind the TypeScript
implementation in functionality, so continue to use the TypeScript
implmentation for the time being. We will publish native executables via
GitHub Releases as soon as we feel the Rust version is usable.
2025-04-24 13:31:40 -07:00
|
|
|
use std::sync::atomic::AtomicU64;
|
|
|
|
|
use std::sync::Arc;
|
|
|
|
|
|
|
|
|
|
use crate::config::Config;
|
|
|
|
|
use crate::protocol::Event;
|
|
|
|
|
use crate::protocol::EventMsg;
|
|
|
|
|
use crate::protocol::Op;
|
|
|
|
|
use crate::protocol::Submission;
|
|
|
|
|
use crate::util::notify_on_sigint;
|
|
|
|
|
use crate::Codex;
|
|
|
|
|
use tokio::sync::Notify;
|
|
|
|
|
|
|
|
|
|
/// Spawn a new [`Codex`] and initialise the session.
|
|
|
|
|
///
|
|
|
|
|
/// Returns the wrapped [`Codex`] **and** the `SessionInitialized` event that
|
|
|
|
|
/// is received as a response to the initial `ConfigureSession` submission so
|
|
|
|
|
/// that callers can surface the information to the UI.
|
|
|
|
|
pub async fn init_codex(
|
2025-04-27 21:47:50 -07:00
|
|
|
config: Config,
|
2025-04-25 12:08:18 -07:00
|
|
|
disable_response_storage: bool,
|
feat: initial import of Rust implementation of Codex CLI in codex-rs/ (#629)
As stated in `codex-rs/README.md`:
Today, Codex CLI is written in TypeScript and requires Node.js 22+ to
run it. For a number of users, this runtime requirement inhibits
adoption: they would be better served by a standalone executable. As
maintainers, we want Codex to run efficiently in a wide range of
environments with minimal overhead. We also want to take advantage of
operating system-specific APIs to provide better sandboxing, where
possible.
To that end, we are moving forward with a Rust implementation of Codex
CLI contained in this folder, which has the following benefits:
- The CLI compiles to small, standalone, platform-specific binaries.
- Can make direct, native calls to
[seccomp](https://man7.org/linux/man-pages/man2/seccomp.2.html) and
[landlock](https://man7.org/linux/man-pages/man7/landlock.7.html) in
order to support sandboxing on Linux.
- No runtime garbage collection, resulting in lower memory consumption
and better, more predictable performance.
Currently, the Rust implementation is materially behind the TypeScript
implementation in functionality, so continue to use the TypeScript
implmentation for the time being. We will publish native executables via
GitHub Releases as soon as we feel the Rust version is usable.
2025-04-24 13:31:40 -07:00
|
|
|
) -> anyhow::Result<(CodexWrapper, Event, Arc<Notify>)> {
|
|
|
|
|
let ctrl_c = notify_on_sigint();
|
|
|
|
|
let codex = CodexWrapper::new(Codex::spawn(ctrl_c.clone())?);
|
|
|
|
|
let init_id = codex
|
|
|
|
|
.submit(Op::ConfigureSession {
|
2025-04-27 21:47:50 -07:00
|
|
|
model: config.model.clone(),
|
|
|
|
|
instructions: config.instructions.clone(),
|
|
|
|
|
approval_policy: config.approval_policy,
|
|
|
|
|
sandbox_policy: config.sandbox_policy,
|
2025-04-25 12:08:18 -07:00
|
|
|
disable_response_storage,
|
feat: initial import of Rust implementation of Codex CLI in codex-rs/ (#629)
As stated in `codex-rs/README.md`:
Today, Codex CLI is written in TypeScript and requires Node.js 22+ to
run it. For a number of users, this runtime requirement inhibits
adoption: they would be better served by a standalone executable. As
maintainers, we want Codex to run efficiently in a wide range of
environments with minimal overhead. We also want to take advantage of
operating system-specific APIs to provide better sandboxing, where
possible.
To that end, we are moving forward with a Rust implementation of Codex
CLI contained in this folder, which has the following benefits:
- The CLI compiles to small, standalone, platform-specific binaries.
- Can make direct, native calls to
[seccomp](https://man7.org/linux/man-pages/man2/seccomp.2.html) and
[landlock](https://man7.org/linux/man-pages/man7/landlock.7.html) in
order to support sandboxing on Linux.
- No runtime garbage collection, resulting in lower memory consumption
and better, more predictable performance.
Currently, the Rust implementation is materially behind the TypeScript
implementation in functionality, so continue to use the TypeScript
implmentation for the time being. We will publish native executables via
GitHub Releases as soon as we feel the Rust version is usable.
2025-04-24 13:31:40 -07:00
|
|
|
})
|
|
|
|
|
.await?;
|
|
|
|
|
|
|
|
|
|
// The first event must be `SessionInitialized`. Validate and forward it to
|
|
|
|
|
// the caller so that they can display it in the conversation history.
|
|
|
|
|
let event = codex.next_event().await?;
|
|
|
|
|
if event.id != init_id
|
|
|
|
|
|| !matches!(
|
|
|
|
|
&event,
|
|
|
|
|
Event {
|
|
|
|
|
id: _id,
|
|
|
|
|
msg: EventMsg::SessionConfigured { .. },
|
|
|
|
|
}
|
|
|
|
|
)
|
|
|
|
|
{
|
|
|
|
|
return Err(anyhow::anyhow!(
|
|
|
|
|
"expected SessionInitialized but got {event:?}"
|
|
|
|
|
));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Ok((codex, event, ctrl_c))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
pub struct CodexWrapper {
|
|
|
|
|
next_id: AtomicU64,
|
|
|
|
|
codex: Codex,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl CodexWrapper {
|
|
|
|
|
fn new(codex: Codex) -> Self {
|
|
|
|
|
Self {
|
|
|
|
|
next_id: AtomicU64::new(0),
|
|
|
|
|
codex,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Returns the id of the Submission.
|
|
|
|
|
pub async fn submit(&self, op: Op) -> crate::error::Result<String> {
|
|
|
|
|
let id = self
|
|
|
|
|
.next_id
|
|
|
|
|
.fetch_add(1, std::sync::atomic::Ordering::SeqCst)
|
|
|
|
|
.to_string();
|
|
|
|
|
self.codex.submit(Submission { id: id.clone(), op }).await?;
|
|
|
|
|
Ok(id)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
pub async fn next_event(&self) -> crate::error::Result<Event> {
|
|
|
|
|
self.codex.next_event().await
|
|
|
|
|
}
|
|
|
|
|
}
|