Skip to content

docs(cli): add Belarusian quickstart guide - #14249

Closed
cuentapraces07-ops wants to merge 1 commit into
BasedHardware:mainfrom
cuentapraces07-ops:bounty-14235-belarusian
Closed

cuentapraces07-ops wants to merge 1 commit into
BasedHardware:mainfrom
cuentapraces07-ops:bounty-14235-belarusian

Conversation

@cuentapraces07-ops

@cuentapraces07-ops cuentapraces07-ops commented Sep 16, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #14235

Summary

Adds sdks/python-cli/examples/quickstart.be.md, a complete Belarusian quickstart for omi-cli.

It covers:

  • pipx and virtualenv installation;
  • browser/API-key authentication and safe credential handling;
  • memory, conversation (including transcript), action-item, and goal commands;
  • JSON output and pagination;
  • named profiles and configuration;
  • the Omi Desktop local API;
  • stable exit codes and retry/error behavior.

The command names, flags, defaults, and exit-code meanings are aligned with the current CLI source and omi_cli/errors.py. This is an isolated docs-only change; no index or source files are modified.

Verification

  • python -m pytest -o addopts= -q — 434 passed, 2 skipped
  • git diff HEAD~1..HEAD --check — clean

Review in cubic

@Git-on-my-level

Copy link
Copy Markdown
Collaborator

Thanks for this — clean docs-only change that matches the bounty scope in #14235 (Belarusian quickstart at sdks/python-cli/examples/quickstart.be.md, no index modifications).

I verified the guide against the current CLI source and everything checks out:

  • Commands and flags: omi auth login --browser with Google/Apple providers (omi_cli/commands/auth.py), the --open filter on action-item list (the secondary of --completed/--open in omi_cli/commands/action_item.py), --include-transcript on conversation list/get (omi_cli/commands/conversation.py), and --args-json on local call with the search_screen_history tool name (omi_cli/commands/local.py) — all present and used with correct syntax.
  • Exit-code table (0–5, incl. 429 → retry after Retry-After) matches omi_cli/errors.py exactly.
  • Config claims: ~/.omi/config.toml default (omi_cli/config.py), settable keys api_base/local_api_url/local_token (omi_cli/commands/config.py), OMI_API_KEY env override, and the omi_dev_ key prefix (omi_cli/auth/api_key.py) — all accurate.
  • Security guidance is appreciated: warning against pasting API keys into shell history, flagging that config.toml may contain secrets, and noting that auth logout only clears local credentials without revoking server-side — that matches auth.py behavior.
  • Links: docs.omi.me CLI intro and the PyPI package both resolve; the relative ../README.md link is correct from examples/.

Nice touches beyond the minimum: the --limit/--offset pagination examples, calling out that local task complete/delete mutate data, and keeping program messages in English so examples stay copy-pasteable.

Leaving a positive signal — a maintainer can merge this as part of the bounty. Great first contribution!


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 positive-signal Automation verified a genuine fix/quality contribution i18n Internationalization / localization changes labels Sep 16, 2026
@Git-on-my-level

Copy link
Copy Markdown
Collaborator

Thanks for this contribution — the guide itself is solid, verified work: command/flag syntax (--include-transcript, --completed/--open, --args-json), the exit-code table matching omi_cli/errors.py, and the config/profile claims all check out.

Unfortunately this PR has been superseded. Bounty issue #14235 was resolved by #14236, merged to main earlier today, which adds a Belarusian quickstart at the same path — sdks/python-cli/examples/quickstart.be.md. Since both branches add that file, GitHub now reports this PR as conflicting, and merging it would replace the already-merged version.

Closing with credit for the quality work. Two ways to keep this alive if you'd like:

  • If your version covers material the merged guide lacks (e.g. the --limit/--offset pagination walkthrough or the credential-safety notes), a follow-up PR patching the merged quickstart.be.md would be welcome.
  • Other unclaimed language quickstarts in sdks/python-cli/examples/ follow the same pattern.

Thanks again for the careful, source-verified documentation.


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

Copy link
Copy Markdown
Collaborator

Superseded by #14236 (same file path on main).

@github-actions

Copy link
Copy Markdown
Contributor

Hey @cuentapraces07-ops 👋

Thank you so much for taking the time to contribute to Omi! We truly appreciate you putting in the effort to submit this pull request.

After careful review, we've decided not to merge this particular PR. Please don't take this personally — we genuinely try to merge as many contributions as possible, but sometimes we have to make tough calls based on:

  • Project standards — Ensuring consistency across the codebase
  • User needs — Making sure changes align with what our users need
  • Code best practices — Maintaining code quality and maintainability
  • Project direction — Keeping aligned with our product principles and locked invariants

Before your next PR, please skim:

  • PRODUCT.md — product north star
  • Product invariants — locked rules (shared chat, memory tiers, agent control plane, integrations, brand)

If this was declined for direction or taste, maintainers should cite an invariant ID or open a proposed one — ask if that citation is missing.

Your contribution is still valuable to us, and we'd love to see you contribute again in the future! If you'd like feedback on how to improve this PR or want to discuss alternative approaches, please don't hesitate to reach out.

Thank you for being part of the Omi community!

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 superseded Superseded by a newer change on main

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Proposed $25 docs bounty: Belarusian (be) Python CLI quickstart

2 participants