Skip to content

docs(sdks/python-cli): add Simplified Chinese quickstart guide - #13350

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

docs(sdks/python-cli): add Simplified Chinese quickstart guide#13350
CreamPle wants to merge 2 commits into
BasedHardware:mainfrom
CreamPle:docs/chinese-simplified-quickstart

Conversation

@CreamPle

@CreamPle CreamPle commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a comprehensive Simplified Chinese quickstart guide for the Omi Python CLI (sdks/python-cli/examples/quickstart.zh-CN.md), providing complete instructions for installation, authentication, memory/conversation/action item workflows, JSON machine-readable integration, configuration, and troubleshooting. Also links the guide in sdks/python-cli/README.md and sdks/python-cli/examples/README.md.

Resolves #13058

Changes

  • sdks/python-cli/examples/quickstart.zh-CN.md: Complete Simplified Chinese quickstart guide.
  • sdks/python-cli/examples/README.md: Reference link to quickstart.zh-CN.md.
  • sdks/python-cli/README.md: Localized quickstart callout link.

Verification

  • Validated markdown formatting, links, and code blocks.
  • Verified diff hygiene with git diff --check HEAD (clean).

Failure-Class: none

Review in cubic

Add Simplified Chinese quickstart guide for the Omi Python CLI (sdks/python-cli/examples/quickstart.zh-CN.md) covering installation, authentication, core command usage, troubleshooting, and navigation links.

Resolves BasedHardware#13058

Co-authored-by: Leper9nome <207575510+Leper9nome@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 this — clean, well-scoped docs contribution, and the guide follows the merged Japanese quickstart (#13099) pattern closely.

Verified against the CLI source on the head commit:

  • examples/quickstart.zh-CN.md — spot-checked the technical claims and they hold up:
    • The exit-code table matches omi_cli/errors.py exactly (EXIT_USAGE=1EXIT_NOT_FOUND=5).
    • The --json placement rule (global flag before the subcommand) matches the root option in omi_cli/main.py, and the correct/incorrect examples are right.
    • OMI_API_KEY matches ENV_API_KEY in omi_cli/config.py, and omi auth login --api-key / --browser (mutually exclusive) match omi_cli/commands/auth.py.
    • memory create --category lifestyle is valid (lifestyle is a MemoryCategory in omi_cli/models.py), and conversation list --limit, conversation get --include-transcript, action-item list --open / complete, and goal list all match their command definitions.
    • The jq examples are correct for JSON mode — title: .structured.title matches Conversation.structured — and the PowerShell ConvertFrom-Json variant is a nice addition.
    • The local Desktop section matches the local command surface (configure --url/--token, status, search-screen --days/--app, default port 47778).
    • The package/command name note (omi-cli on PyPI vs omi at the terminal, per pyproject.toml [project.scripts]) is accurate and genuinely useful — the standalone omi PyPI package is unrelated.
  • README.md and examples/README.md — both discovery links resolve and follow the existing localized-guide callout/list pattern.

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

One merge-order note for maintainers: the open Traditional Chinese guide #13261 edits the same README callout line, so whichever merges second needs a trivial rebase.

This resolves bounty proposal #13058 — leaving the bounty acceptance and merge call to maintainers.


by AI on behalf of David — bounty approval (#13058) and the merge decision need a human maintainer; please @Git-on-my-level if you can take that.

@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 (Simplified Chinese 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 rebased head (9acb7ad):

  • examples/quickstart.zh-CN.md is byte-identical through the merge of origin/main — none of the three PR files changed since 14bb175, so the earlier source verification and @kodjima33's approval both still stand on this head.
  • The Python checks that were failing pre-existing (tests/test_auth_api_key.py transport-failure case) now pass here — the underlying bug was fixed on main in fix(sdks/python-cli): preserve saved credentials on transport failure during login (#13191) #13436 and picked up by the rebase. Removing the now-stale ci-failing-pre-existing label.
  • One note on the agent-facing angle: the guide's header states it is designed for human developers and AI agents, and its auth/JSON/exit-code sections are exactly the parts coding agents tend to follow. I checked those claims against the CLI source on this head (exit-code table vs omi_cli/errors.py, global --json placement vs omi_cli/main.py, OMI_API_KEY vs omi_cli/config.py, local configure/search-screen flags vs omi_cli/commands/local.py) and they are accurate, so the localized agent guidance is safe to publish as-is.

Still open for a maintainer: bounty acceptance for #13058, merge-order with the Traditional Chinese guide #13261 (same README callout line), and the merge itself.


by AI on behalf of David — remaining decisions are the #13058 bounty acceptance and merge timing.

@Git-on-my-level Git-on-my-level removed the ci-failing-pre-existing CI check failing for reasons pre-existing/unrelated to this PR (red main) label Sep 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

Proposed $10 docs bounty: Simplified Chinese Python CLI quickstart

3 participants