@gair/codex-med 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +33 -41
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,71 +1,63 @@
1
- <p align="center"><strong>Codex CLI</strong> is a coding agent from OpenAI that runs locally on your computer.
1
+ <p align="center"><strong>codex-med</strong> a medical-domain coding agent built on top of OpenAI's Codex CLI.</p>
2
+
2
3
  <p align="center">
3
- <img src="https://github.com/openai/codex/blob/main/.github/codex-cli-splash.png" alt="Codex CLI splash" width="80%" />
4
+ Adds biomedical tools (UniProt / GenBank / PDB lookup, antibody training database queries, planned external model gateway) on top of the upstream Codex CLI.
4
5
  </p>
5
- </br>
6
- If you want Codex in your code editor (VS Code, Cursor, Windsurf), <a href="https://developers.openai.com/codex/ide">install in your IDE.</a>
7
- </br>If you want the desktop app experience, run <code>codex app</code> or visit <a href="https://chatgpt.com/codex?app-landing-page=true">the Codex App page</a>.
8
- </br>If you are looking for the <em>cloud-based agent</em> from OpenAI, <strong>Codex Web</strong>, go to <a href="https://chatgpt.com/codex">chatgpt.com/codex</a>.</p>
9
6
 
10
7
  ---
11
8
 
12
9
  ## Quickstart
13
10
 
14
- ### Installing and running Codex CLI
15
-
16
- Run the following on Mac or Linux to install Codex CLI:
11
+ ### Install via npm (Linux x64)
17
12
 
18
13
  ```shell
19
- curl -fsSL https://chatgpt.com/codex/install.sh | sh
14
+ npm install -g @gair/codex-med
20
15
  ```
21
16
 
22
- Run the following on Windows to install Codex CLI:
23
-
24
- ```
25
- powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"
26
- ```
17
+ Currently only `linux-x64` (glibc) prebuilt binaries are published. Other platforms can build from source — see [Building from source](#building-from-source).
27
18
 
28
- Codex CLI can also be installed via the following package managers:
19
+ Then run:
29
20
 
30
21
  ```shell
31
- # Install using npm
32
- npm install -g @openai/codex
22
+ codex-med
33
23
  ```
34
24
 
35
- ```shell
36
- # Install using Homebrew
37
- brew install --cask codex
38
- ```
25
+ ### Sign in
26
+
27
+ Inside the TUI, follow the prompts to sign in with your ChatGPT account or paste an API key. See `docs/config.md` for full configuration reference.
39
28
 
40
- Then simply run `codex` to get started.
29
+ ---
30
+
31
+ ## What's different from upstream Codex
41
32
 
42
- <details>
43
- <summary>You can also go to the <a href="https://github.com/openai/codex/releases/latest">latest GitHub Release</a> and download the appropriate binary for your platform.</summary>
33
+ This is a fork; everything in the upstream README about agents, sandboxing, MCP support, etc. still applies. The medical-fork-specific additions:
44
34
 
45
- Each GitHub Release contains many executables, but in practice, you likely want one of these:
35
+ - **Built-in biomedical lookup tools** — fetch UniProt entries, GenBank records, PDB structures, and search UniProt directly from the agent loop
36
+ - **Antibody training database tool** — read-only SQL queries over a local SQLite database (`training_ready_v1.sqlite`); see `docs/` for schema
37
+ - **External model gateway integration** *(planned)* — see [docs/model-integration.md](docs/model-integration.md) for the design and onboarding guide for connecting self-hosted models (affinity prediction, structure prediction, ADMET, etc.) via MCP
46
38
 
47
- - macOS
48
- - Apple Silicon/arm64: `codex-aarch64-apple-darwin.tar.gz`
49
- - x86_64 (older Mac hardware): `codex-x86_64-apple-darwin.tar.gz`
50
- - Linux
51
- - x86_64: `codex-x86_64-unknown-linux-musl.tar.gz`
52
- - arm64: `codex-aarch64-unknown-linux-musl.tar.gz`
39
+ ---
53
40
 
54
- Each archive contains a single entry with the platform baked into the name (e.g., `codex-x86_64-unknown-linux-musl`), so you likely want to rename it to `codex` after extracting it.
41
+ ## Building from source
55
42
 
56
- </details>
43
+ Requires Rust 1.95+ and Node 16+.
57
44
 
58
- ### Using Codex with your ChatGPT plan
45
+ ```shell
46
+ git clone https://github.com/openai/codex.git codex-med
47
+ cd codex-med/codex-rs
48
+ cargo build --release -p codex-cli --bin codex
49
+ ```
59
50
 
60
- Run `codex` and select **Sign in with ChatGPT**. We recommend signing into your ChatGPT account to use Codex as part of your Plus, Pro, Business, Edu, or Enterprise plan. [Learn more about what's included in your ChatGPT plan](https://help.openai.com/en/articles/11369540-codex-in-chatgpt).
51
+ The binary lands at `codex-rs/target/release/codex`. To package it as an npm tarball locally, see `codex-cli/scripts/build_npm_package.py` and `scripts/stage_npm_packages.py`.
61
52
 
62
- You can also use Codex with an API key, but this requires [additional setup](https://developers.openai.com/codex/auth#sign-in-with-an-api-key).
53
+ ---
63
54
 
64
55
  ## Docs
65
56
 
66
- - [**Codex Documentation**](https://developers.openai.com/codex)
67
- - [**Contributing**](./docs/contributing.md)
68
- - [**Installing & building**](./docs/install.md)
69
- - [**Open source fund**](./docs/open-source-fund.md)
57
+ - [Model integration guide](docs/model-integration.md) — how to plug self-hosted prediction models into the agent
58
+ - [Configuration](docs/config.md)
59
+ - [Contributing](docs/contributing.md)
60
+
61
+ ---
70
62
 
71
63
  This repository is licensed under the [Apache-2.0 License](LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gair/codex-med",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Codex CLI for medical domain agents (fork of OpenAI Codex CLI).",
5
5
  "license": "Apache-2.0",
6
6
  "bin": {
@@ -20,6 +20,6 @@
20
20
  },
21
21
  "packageManager": "pnpm@10.33.0+sha512.10568bb4a6afb58c9eb3630da90cc9516417abebd3fabbe6739f0ae795728da1491e9db5a544c76ad8eb7570f5c4bb3d6c637b2cb41bfdcdb47fa823c8649319",
22
22
  "optionalDependencies": {
23
- "@gair/codex-med-linux-x64": "npm:@gair/codex-med@0.1.0-linux-x64"
23
+ "@gair/codex-med-linux-x64": "npm:@gair/codex-med@0.1.1-linux-x64"
24
24
  }
25
25
  }