Skip to content

01-getting-started.md

Latest commit

 

History

History
72 lines (50 loc) · 2.66 KB

01-getting-started.md

File metadata and controls

72 lines (50 loc) · 2.66 KB
layout default
title Chapter 1: Getting Started
nav_order 1
parent Codex CLI Tutorial

Chapter 1: Getting Started

Welcome to Chapter 1: Getting Started. In this part of Codex CLI Tutorial: Local Terminal Agent Workflows with OpenAI Codex, you will build an intuitive mental model first, then move into concrete implementation details and practical production tradeoffs.

This chapter gets Codex CLI installed and running on your machine.

Learning Goals

  • install Codex CLI with package manager or binary
  • run first interactive session
  • choose ChatGPT sign-in vs API key auth
  • verify basic command loop behavior

Quick Install Paths

  • npm i -g @openai/codex
  • brew install --cask codex
  • or download binaries from latest release

Source References

Summary

You now have a working Codex CLI baseline.

Next: Chapter 2: Architecture and Local Execution Model

Source Code Walkthrough

README.md

The README.md is the primary reference for this chapter. It covers all three installation methods (npm global, brew, binary), the two authentication paths (ChatGPT sign-in for Plus/Pro users, API key for API users), and the quickstart command loop. The Quickstart section maps directly to the goals of this chapter.

The README also explains the three approval modes (suggest, auto-edit, full-auto) which determine how much autonomy Codex has during a session — a key configuration decision to understand before your first run.

codex-cli/package.json

The codex-cli/package.json shows the npm package metadata: the published package name (@openai/codex), the entry point, and the bin field that maps codex to the CLI executable. This confirms the install path and helps diagnose PATH issues after global npm install.

How These Components Connect

flowchart TD
    A[Install: npm i -g @openai/codex or brew or binary]
    B[Configure auth: ChatGPT sign-in or OPENAI_API_KEY]
    C[Run: codex in project directory]
    D[Interactive session starts]
    E[Choose approval mode: suggest auto-edit or full-auto]
    F[Submit task in natural language]
    G[Codex proposes edits or commands]
    H[User approves or rejects]
    A --> B
    B --> C
    C --> D
    D --> E
    E --> F
    F --> G
    G --> H
Loading