# codex-linux

**Repository Path**: zjp369/codex-linux

## Basic Information

- **Project Name**: codex-linux
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-08
- **Last Updated**: 2026-06-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Codex Linux

A Linux port of OpenAI Codex - A powerful command center for managing multiple AI coding agents in parallel.

## Features

- **Multi-Agent Orchestration**: Manage multiple AI agents working in parallel on different tasks
- **Git Worktrees**: Isolate agent changes in separate worktrees for safe experimentation
- **Skills System**: Create and apply reusable skills to customize agent behavior
- **Automation**: Schedule recurring tasks and create automated workflows
- **Multi-Provider Support**: Works with OpenAI (GPT-4, GPT-5, Codex) and Anthropic (Claude) models
- **Change Review**: Review, approve, or reject agent code changes before applying
- **Linux Native**: Built specifically for Linux with AppImage, deb, and rpm packages

## Installation

### Quick Install (Recommended)

```bash
curl -fsSL https://raw.githubusercontent.com/ranker-002/codex-linux/master/scripts/install.sh | bash
```

This will install Codex Linux to `~/.local/bin` and add it to your PATH.

### Via npm

```bash
npm install -g codex-linux
```

### System-wide Install

```bash
curl -fsSL https://raw.githubusercontent.com/ranker-002/codex-linux/master/scripts/install.sh | sudo bash -s -- --system
```

### Download AppImage

Download the latest AppImage from [GitHub Releases](https://github.com/ranker-002/codex-linux/releases/latest):

```bash
# Download
curl -L -o Codex.Linux-1.0.4.AppImage https://github.com/ranker-002/codex-linux/releases/latest/download/Codex.Linux-1.0.4.AppImage

# Make executable
chmod +x Codex.Linux-1.0.4.AppImage

# Run
./Codex.Linux-1.0.4.AppImage
```

### From Source

```bash
# Clone the repository
git clone https://github.com/ranker-002/codex-linux.git
cd codex-linux

# Install dependencies
pnpm install

# Build the application
npm run build

# Run in development mode
npm run dev

# Package for Linux
npm run package:linux
```

## Quick Start

1. **Launch Codex Linux** - Run the application from your applications menu or terminal:

   ```bash
   codex-linux
   ```

2. **Configure AI Provider**:
   - Go to Settings → AI Providers
   - Add your OpenAI or Anthropic API key
   - Test the connection

3. **Create Your First Agent**:
   - Click "+ New Agent"
   - Select a project folder
   - Choose a provider and model
   - Optionally apply skills

4. **Start Coding**:
   - Send messages to your agent
   - Assign tasks for parallel execution
   - Review changes in worktrees

## Configuration

### Environment Variables

```bash
# Optional: Set default API keys
export OPENAI_API_KEY="your-key-here"
export ANTHROPIC_API_KEY="your-key-here"
```

### Settings File

Settings are stored in `~/.config/codex/config.json`:

```json
{
  "theme": "dark",
  "defaultProvider": "openai",
  "defaultModel": "gpt-4o",
  "maxParallelAgents": 5,
  "shortcuts": {
    "agent:new": "Ctrl+Shift+N",
    "agent:send": "Ctrl+Enter"
  }
}
```

## Skills

Skills are reusable instructions that customize agent behavior:

1. Create skills in the Skills panel
2. Write instructions in markdown
3. Apply skills to agents when creating or editing

### Example Skill Structure

```
~/.config/codex/skills/my-skill/
├── skill.yaml          # Skill metadata
├── instructions.md     # Core instructions
└── templates/
    └── code-review.md  # Review template
```

## Automations

Create automated workflows:

- **Schedule**: Run on cron schedule (e.g., daily code review)
- **Event**: Trigger on git events or file changes
- **Webhook**: Trigger via HTTP requests
- **Manual**: Run on demand

## Worktrees

Git worktrees provide isolated environments for each agent:

- Changes are isolated from main branch
- Easy to review and merge
- Automatic cleanup on agent deletion
- Visual diff and merge tools

## Keyboard Shortcuts

| Action | Shortcut |
|--------|----------|
| New Agent | `Ctrl+Shift+N` |
| Send Message | `Ctrl+Enter` |
| New Worktree | `Ctrl+Shift+W` |
| Open Skills | `Ctrl+Shift+S` |
| Open Automations | `Ctrl+Shift+A` |
| Open Settings | `Ctrl+,` |
| Command Palette | `Ctrl+Shift+P` |

## Architecture

```
codex-linux/
├── src/
│   ├── main/              # Electron main process
│   │   ├── agents/        # Agent orchestration
│   │   ├── git/           # Git worktree management
│   │   ├── skills/        # Skills system
│   │   ├── automations/   # Automation scheduler
│   │   └── providers/     # AI provider integrations
│   ├── renderer/          # React frontend
│   │   └── components/    # UI components
│   └── shared/            # Shared types
├── assets/                # Icons and images
└── tests/                 # Test suites
```

## Development

### Prerequisites

- Node.js 18+
- pnpm (recommended) or npm
- Git

### Running Tests

```bash
npm test
```

### Linting

```bash
npm run lint
npm run lint:fix
```

### Type Checking

```bash
npm run typecheck
```

## Uninstall

```bash
codex-linux --uninstall
# or
~/.local/bin/uninstall-codex-linux.sh
```

## Contributing

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## License

MIT License - see [LICENSE](LICENSE) file for details.

## Acknowledgments

- Inspired by OpenAI Codex
- Built with Electron, React, and TypeScript
- Uses Simple Git for git operations
- Icons by Lucide

## Support

- GitHub Issues: [Report bugs or request features](https://github.com/ranker-002/codex-linux/issues)
- GitHub Releases: [Download latest version](https://github.com/ranker-002/codex-linux/releases)