Skip to content

Commit f133fa1

Browse files
committed
Document Codex CLI auth prerequisite in README
1 parent db33726 commit f133fa1

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ If no new rule is detected -> do not update the file.
174174
- For this project, remove legacy/compatibility shims immediately (including `[Obsolete]` bridges and duplicate old properties); keep only the current API surface.
175175
- README first examples must be beginner-friendly: avoid advanced/optional knobs (for example `CodexExecutablePath`) in the very first snippet.
176176
- README in this repository must describe only current first-version product behavior; do not add migration/legacy compatibility sections or old-namespace guidance.
177+
- README must explicitly state runtime prerequisites: `codex` CLI installed and user already authenticated (`codex login`) before SDK usage.
177178
- When a README snippet shows model tuning, include `ModelReasoningEffort` together with `Model`.
178179
- Public examples should build output schemas with typed `StructuredOutputSchema` models and map responses to typed DTOs for readability and maintainability.
179180
- Do not keep or add `JsonSchema` helper abstractions in SDK API/tests; use typed request/response DTO models instead of schema-builder utilities.

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,19 @@ All consumer usage examples are documented in this README; this repository inten
2424
dotnet add package ManagedCode.CodexSharpSDK
2525
```
2626

27+
## Prerequisites
28+
29+
Before using this SDK, you must have:
30+
- `codex` CLI installed and available in `PATH`
31+
- an already authenticated Codex session (`codex login`)
32+
33+
Quick check:
34+
35+
```bash
36+
codex --version
37+
codex login
38+
```
39+
2740
## Quickstart
2841

2942
```csharp

0 commit comments

Comments
 (0)