Skip to content

[good first issue] Add Codex CLI setup guide #9

@GoDiao

Description

@GoDiao

Goal

Add a copy-paste-ready setup guide for OpenAI Codex CLI in the README (or docs/agents/codex.md).

Required content

  1. Environment variables to set:
    • OPENAI_BASE_URL=http://localhost:8787/v1
    • OPENAI_API_KEY=<your FREEWAY_API_KEY>
  2. How Codex CLI picks models and how to map to Freeway model IDs
  3. Verification step

Acceptance criteria

  • A new user can follow the guide and have Codex CLI talking to Freeway in under 2 minutes
  • The guide is linked from the main README

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions