Skip to content

docs: align German CLI quickstart with current behavior - #14239

Open
QIU-Guanzong wants to merge 1 commit into
BasedHardware:mainfrom
QIU-Guanzong:codex/german-cli-14215
Open

QIU-Guanzong wants to merge 1 commit into
BasedHardware:mainfrom
QIU-Guanzong:codex/german-cli-14215

Conversation

@QIU-Guanzong

@QIU-Guanzong QIU-Guanzong commented Sep 16, 2026

Copy link
Copy Markdown

Updates the German guide for #14215: corrects exit codes, explains profile and environment precedence, and adds OAuth refresh and local Desktop API guidance. The README already links to this guide, so no duplicate link is added.

Checked the wording against the CLI implementation. All 435 CLI tests passed (one Windows-only test skipped), and 32 documented commands passed help/version checks with an isolated, empty configuration. Live login and account data operations were not exercised. Local preflight passed all 11 checks.

AI-assisted with OpenAI Codex.

Closes #14215.

Product invariants affected

none

Review in cubic

@Git-on-my-level Git-on-my-level added positive-signal Automation verified a genuine fix/quality contribution docs-tooling Layer: Documentation, examples, dev tools labels Sep 16, 2026
@Git-on-my-level

Copy link
Copy Markdown
Collaborator

Thanks @QIU-Guanzong — this is a careful, well-sourced update to sdks/python-cli/examples/quickstart.de.md. I verified the rewritten guidance against the CLI source at this HEAD:

  • Exit codes: the new table (0/1/2/3/4/5) matches omi_cli/errors.py's EXIT_* contract exactly, including 4 = HTTP 429 and 5 = HTTP 404, which the previous version omitted. The note that Click-caught usage errors (unknown flag, missing arg) also exit 2 matches the exception ladder in omi_cli/main.py (click.ClickException → its built-in code).
  • Auth: auth refresh erroring with exit 1 on API-key profiles matches the UsageError in omi_cli/commands/auth.py; the local-config-only auth status vs network auth whoami distinction matches their implementations; the hidden key input in the interactive prompt matches typer.prompt(..., hide_input=...).
  • Env vars & profiles: stored-key precedence over OMI_API_KEY — and the env var switching an OAuth profile to API-key auth for that call — match AppContext.get_profile() in omi_cli/main.py. The precedence chain --profile/-pOMI_PROFILEactive_profiledefault matches resolve_profile_name() in omi_cli/config.py, and all six documented env vars exist there.
  • Commands: every documented command/flag exists (--include-transcript, --category, goal progress/history, action-item complete, ask, local search-screen --days --app, local screenshot --output, local sql), requires-python = ">=3.10" matches pyproject.toml, and the footer links (agent_quickstart.md, shell_examples.sh) resolve. Skipping a duplicate README link is right since the README already links this guide.

Worth noting for script authors and AI agents: this guide doubles as agent-facing usage documentation — omi_cli/errors.py declares the exit-code contract "stable for agent use", and agent_quickstart.md sits alongside it. The old table taught agents that every exit 2 means "re-login", which would misfire on plain usage errors and miss 429/404 handling; the corrected table changes that for the better. Nothing here steers agents anywhere unsafe — the guidance checks out against the implementation.

Minor, non-blocking: section order differs from the fr/pt/it siblings (Profiles before the local Desktop API section). Fine to keep unless template consistency across translations becomes a goal.

Leaving merge sign-off to a human maintainer — this closes bounty issue #14215, so the merge and bounty-credit call belongs to a person.


by AI on behalf of David — if you need David’s attention urgently, please @Git-on-my-level and escalate with need human response.

@kodjima33 kodjima33 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-correctness verified: new exit-code table matches sdks/python-cli/omi_cli/errors.py exactly (1=usage,2=auth,3=server,4=rate-limited,5=not-found), and the 'auth refresh' command referenced actually exists (commands/auth.py:219). Merging.

@kodjima33 kodjima33 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-affirming prior approval (already APPROVED by kodjima33): German quickstart content previously verified accurate. Now DIRTY due to unrelated concurrent doc merges -- approve only, needs author/manual rebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-tooling Layer: Documentation, examples, dev tools positive-signal Automation verified a genuine fix/quality contribution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Proposed $25 docs bounty: German (de) Python CLI quickstart

4 participants