Skip to content

docs(cli): document serve request timeout #1278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
steipete merged 1 commit into from
Jun 7, 2026
+13 −1
Merged

docs(cli): document serve request timeout #1278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Sources/CodexBarCLI/CLIHelp.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ extension CodexBarCLI {

Usage:
codexbar serve [--port <port>] [--refresh-interval <seconds>]
[--request-timeout <seconds>]
[--json-output] [--log-level <trace|verbose|debug|info|warning|error|critical>]
[-v|--verbose]

Expand All @@ -95,7 +96,7 @@ extension CodexBarCLI {

Examples:
codexbar serve
codexbar serve --port 8080 --refresh-interval 60
codexbar serve --port 8080 --refresh-interval 60 --request-timeout 30
curl http://127.0.0.1:8080/usage?provider=all
"""
}
Expand Down Expand Up @@ -209,6 +210,7 @@ extension CodexBarCLI {
[--json-output] [--log-level <trace|verbose|debug|info|warning|error|critical>] [-v|--verbose]
[--provider \(ProviderHelp.list)] [--no-color] [--pretty] [--refresh]
codexbar serve [--port <port>] [--refresh-interval <seconds>]
[--request-timeout <seconds>]
[--json-output] [--log-level <trace|verbose|debug|info|warning|error|critical>] [-v|--verbose]
codexbar config <validate|dump|providers> [--format text|json]
[--json]
Expand Down
10 changes: 10 additions & 0 deletions Tests/CodexBarTests/CLIServeRouterTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,16 @@ struct CLIServeRouterTests {
flags: [])) == 30)
}

@Test
func `serve help documents request timeout option`() {
let serve = CodexBarCLI.serveHelp(version: "0.0.0")
let root = CodexBarCLI.rootHelp(version: "0.0.0")

#expect(serve.contains("--request-timeout <seconds>"))
#expect(serve.contains("codexbar serve --port 8080 --refresh-interval 60 --request-timeout 30"))
#expect(root.contains("--request-timeout <seconds>"))
}

@Test
func `serve cache skips provider error payloads`() {
let success = CLILocalHTTPResponse(
Expand Down