Skip to content

docs(sdks/python-cli): add Spanish quickstart guide (#13292) - #13346

Open
CreamPle wants to merge 2 commits into
BasedHardware:mainfrom
CreamPle:docs/spanish-quickstart
Open

docs(sdks/python-cli): add Spanish quickstart guide (#13292)#13346
CreamPle wants to merge 2 commits into
BasedHardware:mainfrom
CreamPle:docs/spanish-quickstart

Conversation

@CreamPle

@CreamPle CreamPle commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Resolves #13292

Summary

Adds a localized Spanish quickstart guide (examples/quickstart.es.md) for omi-cli.

Details

  • Covers pipx and pip installation, explicitly clarifying the distinction between the package name (omi-cli) and executable command (omi).
  • Documents interactive and direct login flows for both Developer API keys and browser OAuth.
  • Provides practical examples for memories, conversations, action items, and goals.
  • Demonstrates JSON mode (--json) pipelines with jq and PowerShell ConvertFrom-Json.
  • Documents standard CLI exit codes, environment variables (OMI_API_KEY), local desktop integration, and multi-profile management.
  • Adds discovery links in examples/README.md and sdks/python-cli/README.md.

Failure-Class: none

Co-authored-by: moon1ight13089703-cmyk 314925028+moon1ight13089703-cmyk@users.noreply.github.com

Review in cubic

)

Add quickstart.es.md for omi-cli with instructions covering installation, browser and API key authentication, CLI and JSON commands, shell environment variables, local desktop integration, and profile management.

Co-authored-by: moon1ight13089703-cmyk <314925028+moon1ight13089703-cmyk@users.noreply.github.com>

@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.

No issues found across 3 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Re-trigger cubic

@Git-on-my-level

Copy link
Copy Markdown
Collaborator

Thanks for the Spanish quickstart — well-scoped, and the structure mirrors the merged Japanese guide (#13099), which keeps the localized set consistent.

I verified the guide's technical claims against the CLI source on main:

  • examples/quickstart.es.md
    • The exit-code table (0–5) matches omi_cli/errors.py exactly.
    • The --json placement rule (global flag before the subcommand) matches the root callback in omi_cli/main.py.
    • The auth section is accurate: --api-key / --browser are the two login flags (mutually exclusive), the interactive 1) Browser / 2) API key picker matches omi auth login's prompt flow, and the auth status (local) vs auth whoami (networked) distinction is correct.
    • Resource examples check out: memory create "..." --category lifestyle (lifestyle is a valid MemoryCategory), conversation list --limit, conversation get --include-transcript, action-item list --open / action-item complete, and goal list.
    • The local Desktop section matches omi local configure/status/search-screen, including --days/--app and the default port 47778; the profiles section matches the global --profile flag and ~/.omi/config.toml.
  • sdks/python-cli/README.md and sdks/python-cli/examples/README.md — both discovery links are correct relative paths and resolve to the new file.

CI note: the three failing Python checks (Linux / Python 3.10, Linux / Python 3.12, Windows ACL / Python 3.12) all fail in tests/test_auth_api_key.py::test_transport_failure_during_login_leaves_saved_config_unchanged, which fails identically on the latest main runs — pre-existing and unrelated to this docs-only change. Labeled accordingly.

One optional polish: the Korean guide notes that OMI_API_KEY only takes effect when the active profile has no stored key (so auth logout first) — worth considering for parity, but not blocking.

This resolves bounty proposal #13292; the acceptance and eligibility call there belongs to the maintainers. Leaving for human maintainer review for the merge decision.


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

@Git-on-my-level Git-on-my-level added docs-tooling Layer: Documentation, examples, dev tools 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
Resolve discovery link and quickstart content conflicts
@Git-on-my-level

Copy link
Copy Markdown
Collaborator

Thanks again for this guide — the content itself holds up, but main moved after the earlier automated review, so this PR now needs a scoping call.

What changed: #13408 landed on Sep 10 with a shorter Spanish quickstart (examples/quickstart.es.md, 121 lines) plus the same examples-README discovery link. This branch then merged origin/main in (b00cfb1), so sdks/python-cli/examples/README.md is now identical to main (no-op in this PR), and the remaining diff replaces the merged 121-line guide with this fuller 226-line version (+176 −71).

Content check: the head file is byte-identical to commit e65b39c that the earlier automated review verified against the CLI source, and I re-confirmed the key claims on current main: the exit-code table (0–5) matches omi_cli/errors.py; the --json global-flag placement matches omi_cli/main.py; the auth status (local) vs auth whoami (networked) split and login flags are accurate; the memory/conversation/action-item/goal examples match the command surface; the local Desktop section's default port 47778 matches the local API default exercised in tests/test_local.py; and ~/.omi/config.toml + global --profile match omi_cli/config.py. No behavior changes, and every link points to official Omi properties.

The tradeoff: #13408's version covers --offset pagination and the save-to-file stderr/empty-file caveats; this version instead adds exit codes, OMI_API_KEY per-shell setup, PowerShell JSON handling, local Desktop integration, and profiles. Both are accurate — they're different guides for the same file.

So this needs a maintainer decision: close as superseded by #13408, or adopt this fuller version as the replacement — in the latter case, folding in #13408's --offset note and the "OMI_API_KEY only applies when the active profile has no stored key" caveat (as the Japanese/Korean guides note) would give it full parity. The #13292 bounty acceptance and eligibility call also stays with the maintainers.

I'm leaving this open rather than closing it, since either outcome is reasonable; labeled superseded + needs-maintainer-review accordingly, and removed positive-signal because the verified equivalent content has already landed on main.


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

@Git-on-my-level Git-on-my-level added superseded Superseded by a newer change on main needs-maintainer-review Needs a human maintainer to sign off before merge and removed ci-failing-pre-existing CI check failing for reasons pre-existing/unrelated to this PR (red main) positive-signal Automation verified a genuine fix/quality contribution labels Sep 11, 2026
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 needs-maintainer-review Needs a human maintainer to sign off before merge superseded Superseded by a newer change on main

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

2 participants