Skip to content

Repository files navigation

⚡ Acode Codex

Native OpenAI Codex CLI Integration for Acode Editor on Android

Build Status Acode Version OpenAI Codex License: MIT GitHub Release

Harness OpenAI's official Codex terminal coding agent directly inside Acode's native terminal environment.

Quick InstallKey FeaturesUsageCommand ReferenceArchitectureTroubleshooting


🌟 Overview

Acode Codex bridges the official OpenAI Codex CLI (@openai/codex) and Acode Editor on Android. It runs the native codex terminal agent inside Acode's xterm.js terminal with full interactive TUI, multiline code editing, automated code reviews, diff inspection, and active workspace binding.


✨ Key Features

  • Native Execution: Runs official @openai/codex (v0.147.0) directly on Android ARM64 via Alpine Node.js.
  • 📺 Interactive TUI: Full interactive terminal user interface powered by Acode's native xterm.js Terminal API (acode.require('terminal')).
  • 📂 Workspace Binding: Automatically opens Codex bound to your active project workspace directory.
  • ⌨️ Keyboard Shortcuts: Launch Codex instantly using Ctrl+Alt+C (Cmd+Alt+C on macOS).
  • 🔍 Automated Code Review: Dedicated codex review shortcut for reviewing active project diffs.
  • 🛠️ Built-in Self-Healing: Includes automated diagnostic (codex-check), repair (codex-repair), and update (codex-update) commands.
  • 📌 Persistent PATH Hooks: Automatically configures $HOME/.local/bin in ~/.bashrc, ~/.profile, and ~/.zshrc.

📦 Installation

Option 1: 1-Click Remote Installation in Acode (Recommended)

  1. Open Acode on your Android device.
  2. Navigate to SettingsPlugins+Remote.
  3. Paste the official release URL:
    https://github.com/The-habib/acode-codex/releases/download/v1.0.0/acode-codex.zip
    
  4. Tap Install and enjoy!

🎮 Usage

1. Terminal Command Line

Open Acode Terminal tab and run:

codex

To run a non-interactive single prompt:

codex "explain this codebase to me"

To run an automated code review on your project:

codex review

2. Acode Command Palette (Ctrl+Shift+P)

Search for Codex to access all integrated actions:

Command Shortcut Description
Codex: Launch Ctrl+Alt+C Launches codex in an interactive Acode Terminal tab
Codex: Review Code Runs codex review on active workspace
Codex: Check Installation Displays environment diagnostic status
Codex: Repair Repairs npm dependencies or binary permissions
Codex: Update Checks for and installs latest Codex CLI updates
Codex: Show Environment Opens interactive status and settings dialog

⚙️ Command Line Tooling Included

The plugin installs 5 helper utilities into $HOME/.local/bin:

Utility Description
codex Primary launcher for OpenAI Codex CLI
codex-setup Configures Node.js runtime & global npm packages
codex-check Performs deep environment diagnostic tests
codex-repair Self-healing script for permission or npm package recovery
codex-update Upgrades @openai/codex via npm

🏗️ Architecture

 ┌───────────────────────────────────────────────────────────┐
 │                   Acode Android Editor                    │
 ├─────────────────────────────┬─────────────────────────────┤
 │    Acode Terminal API       │   Commands & Status Dialog  │
 └──────────────┬──────────────┴──────────────┬──────────────┘
                │                             │
                ▼                             ▼
 ┌───────────────────────────────────────────────────────────┐
 │                 Alpine Linux Container                    │
 ├───────────────────────────────────────────────────────────┤
 │  $HOME/.local/bin/codex  ──►  Node.js v22 @openai/codex   │
 │                                      │                    │
 │                                      ▼                    │
 │                           OpenAI Codex Agent Engine       │
 └───────────────────────────────────────────────────────────┘
Component Technical Detail
Runtime Environment Node.js v22.23.2
CLI Package @openai/codex v0.147.0
Terminal Integration acode.require('terminal') -> createServer()
Manifest Spec Acode Plugin Standard v2 (minVersionCode: 292)

🔍 Troubleshooting & Diagnostics

If codex ever requires inspection, run the diagnostic suite in terminal:

codex doctor

Or run:

codex-check

To repair permissions or upgrade dependencies, run:

codex-repair

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests on our GitHub Repository.

# Clone project
git clone https://github.com/The-habib/acode-codex.git
cd acode-codex

# Install dependencies & build
npm install
npm run build
npm run test

📄 License & Attribution

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages