Skip to content

docs(sdks/python-cli): add German quickstart guide (#13360) - #13361

Open
CreamPle wants to merge 3 commits into
BasedHardware:mainfrom
CreamPle:docs/german-quickstart
Open

docs(sdks/python-cli): add German quickstart guide (#13360)#13361
CreamPle wants to merge 3 commits into
BasedHardware:mainfrom
CreamPle:docs/german-quickstart

Conversation

@CreamPle

@CreamPle CreamPle commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Resolves #13360.

Adds a comprehensive, idiomatic German quickstart guide (sdks/python-cli/examples/quickstart.de.md) for omi-cli:

  • Package name (omi-cli) vs binary executable (omi)
  • Installation methods via pipx (recommended isolated environment) and pip
  • Complete authentication walkthrough:
    • Interactive browser login (omi auth login --browser)
    • Headless API-key login (omi auth login --api-key) and environment variable (OMI_API_KEY)
    • Offline status inspection (omi auth status) vs live server verification (omi auth whoami)
  • Primary resource workflows for memories, conversations, action items, and goals
  • Structured automation guidelines with global --json option and jq recipes
  • Detailed exit codes reference table (0, 1, 2, 3, 4, 5)
  • Cross-platform shell snippets for Linux/macOS (Bash/Zsh) and Windows (PowerShell with $LASTEXITCODE validation)
  • Local Omi Desktop API integration (omi local configure, omi local search-screen)
  • Multi-environment profile management (--profile, ~/.omi/config.toml)
  • Security recommendations for credentials and shell history
  • Discovery links added in sdks/python-cli/README.md and sdks/python-cli/examples/README.md

Failure-Class: none

Review in cubic

Add comprehensive German quickstart guide (examples/quickstart.de.md) covering installation, authentication (browser and API key), core resources (memories, conversations, action items, goals), automation with --json, standardized exit codes, shell syntax for Bash, Zsh, and PowerShell (including \ handling), local Desktop API, profile management, and security best practices. Links added to README discovery sections.

Failure-Class: none

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

All reported issues were addressed across 3 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread sdks/python-cli/examples/quickstart.de.md Outdated
Comment thread sdks/python-cli/examples/quickstart.de.md Outdated
Comment thread sdks/python-cli/examples/quickstart.de.md Outdated
…y, and Click exit codes in German guide

Failure-Class: none
@Git-on-my-level

Copy link
Copy Markdown
Collaborator

Thanks @CreamPle — I verified this guide against the CLI implementation at the PR head; it is accurate throughout, and all three inline notes from the earlier automated review run are addressed on this head.

sdks/python-cli/examples/quickstart.de.md — spot-checked every claim against code:

  • The exit-code table (0–5) mirrors the stable contract in omi_cli/errors.py (EXIT_OKEXIT_NOT_FOUND), including the subtle nuance that Click's own parser errors (missing args, unknown options) exit 2 while application validation exits 1 — rows 1 and 2 call that out explicitly. Easy detail to get wrong; nicely handled.
  • Auth section matches omi_cli/commands/auth.py: the interactive picker (1 Browser / 2 API key), --browser with --provider apple for Apple, --api-key, and the offline auth status vs live auth whoami distinction — including that the expiry field is surfaced only for OAuth profiles.
  • OMI_API_KEY as the environment-variable fallback matches the env handling in omi_cli/main.py.
  • memory create --category workwork is a valid MemoryCategory in omi_cli/models.py; conversation get <ID> --include-transcript, action-item list --open / action-item complete, and goal create --type numeric --target 2 --unit liters all match their command signatures in omi_cli/commands/.
  • The --json placement rule (global option before the subcommand) matches the root callback option in omi_cli/main.py, and profile management persisted at ~/.omi/config.toml matches omi_cli/config.py.
  • Local Desktop section matches omi_cli/commands/local.py (configure --url/--token, status, search-screen --days 7 --app Safari), consistent with the README's 127.0.0.1:47778 example.

sdks/python-cli/README.md and sdks/python-cli/examples/README.md — both discovery links point at the new file with correct relative paths and formatting consistent with the existing Japanese guide entries.

Checks note: the three failing Python jobs all fail on tests/test_auth_api_key.py::test_transport_failure_during_login_leaves_saved_config_unchanged, which fails identically on today's other quickstart-translation PR runs of the same workflow — this PR touches no Python, so that failure is pre-existing and not caused by this change.

Non-blocking note: as with the Japanese guide, a translated quickstart can drift as the CLI evolves — treat the English README as the source of truth when the CLI changes.

No blocking issues from my side; leaving formal approval to a human maintainer.


by AI on behalf of David — @Git-on-my-level if a human decision is needed on this.

@Git-on-my-level Git-on-my-level added i18n Internationalization / localization changes positive-signal Automation verified a genuine fix/quality contribution ci-failing-pre-existing CI check failing for reasons pre-existing/unrelated to this PR (red main) labels Sep 10, 2026

@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-only i18n addition (German quickstart), labeled ci-failing-pre-existing. Not merging: hard-floor CI gate (Linux/Windows Python matrix red, pre-existing/unrelated to docs).

Resolve discovery link conflicts in sdks/python-cli/README.md and examples/README.md
@Git-on-my-level

Copy link
Copy Markdown
Collaborator

Follow-up on the new head after the merge from main (b802c63):

  • The branch's delta against main is exactly the three files in this PR — the merge commit introduces nothing beyond them.
  • examples/quickstart.de.md is byte-identical (blob d2ba0446) to the commit the maintainer approval was made on, so that approval still covers the guide's content; the only README movement since then is main's own Spanish-quickstart links and --json version note coming in from the merge.
  • Re-ran the accuracy spot-checks from my earlier comment against the merged tree — exit-code table vs omi_cli/errors.py, auth flags vs omi_cli/commands/auth.py, local configure / local search-screen signatures vs omi_cli/commands/local.py, and the 127.0.0.1:47778 convention — all still hold, and the relevant CI jobs are green on this head.

From my side this is ready to merge whenever a maintainer picks it up. Thanks @CreamPle!


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

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

Labels

ci-failing-pre-existing CI check failing for reasons pre-existing/unrelated to this PR (red main) i18n Internationalization / localization changes positive-signal Automation verified a genuine fix/quality contribution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bounty proposal] German quickstart for omi-cli ($25 proposed)

3 participants