Skip to content

QUICK_START_CODEX.md

Latest commit

 

History

History
165 lines (124 loc) · 4.75 KB

QUICK_START_CODEX.md

File metadata and controls

165 lines (124 loc) · 4.75 KB

Codex Quick Start (5 Minutes)

Get started with Codex CLI integration in Amplifier in just 5 minutes. This quick start guide covers the essential steps to begin using Codex with the Amplifier project.

What You'll Learn

  • Installing prerequisites
  • Starting your first Codex session
  • Using basic MCP tools
  • Understanding key concepts

Prerequisites

Before starting, you'll need:

Table of Contents

  1. Prerequisites (1 minute)
  2. First Session (2 minutes)
  3. Key Concepts (1 minute)
  4. Common Commands (1 minute)
  5. Next Steps

Prerequisites (1 minute)

  1. Verify Codex installation:

    # Follow Anthropic's installation guide
# https://docs.anthropic.com/codex/installation
codex --version

  2. Clone the project:

    git clone <repository-url>
cd amplifier-project

  3. Install dependencies:

    make install

First Session (2 minutes)

  1. Start the wrapper script:

    ./amplify-codex.sh

    What you'll see:

    🔧 Amplifier Codex Integration
✅ Prerequisites verified
📚 Loading session context...
🚀 Starting Codex with development profile

Available MCP Tools:
• initialize_session - Load memories
• check_code_quality - Run quality checks
• save_current_transcript - Export session
• create_task - Manage tasks
• search_web - Web research

Type your prompt or use MCP tools...

  2. Try initializing a session:

    codex> initialize_session with prompt "Hello world"

    Expected output:

    Loaded 3 relevant memories from previous sessions.
Session context ready for "Hello world" development.

  3. Try a quality check:

    codex> check_code_quality with file_paths ["README.md"]

    Expected output:

    Quality check passed ✅
• Lint: OK (ruff)
• Type check: OK (pyright)
• Tests: 15 passed (pytest)
Execution time: 2.3s

Key Concepts (1 minute)

  • MCP Tools vs Hooks: Codex uses MCP (Model Context Protocol) servers instead of Claude Code's native hooks. Tools are invoked via natural language or direct calls.

  • Profiles: Choose the right tool set:

    • development: All tools (session, quality, transcripts, tasks, web)
    • ci: Quality checks only
    • review: Quality + transcripts

  • Memory System: Automatically loads relevant context from past sessions to maintain continuity.

Common Commands (1 minute)

Session Management:

codex> initialize_session with prompt "Working on feature"
codex> finalize_session with recent messages
codex> save_current_transcript with format "both"

Quality Checks:

codex> check_code_quality with file_paths ["src/file.py"]
codex> run_specific_checks with check_type "lint"

Task Tracking:

codex> create_task with title "Fix bug" and description "Login issue"
codex> list_tasks with filter_status "pending"
codex> complete_task with task_id "task_123"

Web Research:

codex> search_web with query "python async patterns" and num_results 5
codex> fetch_url with url "https://example.com/guide" and extract_text true

Next Steps

Congratulations! You've completed the 5-minute quick start. Now you know how to:

  • ✅ Start a Codex session with Amplifier integration
  • ✅ Use basic MCP tools for session management and quality checks
  • ✅ Understand profiles and memory system concepts
  • ✅ Execute common development commands

Continue learning:

Need help? Check the troubleshooting guide or open an issue in the project repository.

Summary

In this quick start, you learned:

  • How to verify prerequisites and install dependencies
  • Starting your first Codex session using the wrapper script
  • Basic MCP tool usage (session management, quality checks, tasks, web research)
  • Key concepts: MCP tools vs hooks, profiles, and memory system
  • Common commands for session management and development workflows

Next up: Dive into the Beginner Guide for a comprehensive 30-minute walkthrough covering all advanced features, agents, and best practices.