Shell completions for Bash, Zsh # 128 by Sravan1011 · Pull Request #192 · usemoss/moss

Sravan1011 · 2026-04-30T12:57:50Z

Screencast.from.2026-04-30.18-22-22.webm

Shell Completions (moss completions command)

Implementation (completions.py): Added a new top-level moss completions [bash|zsh] command.
Full Command Hierarchy Coverage: The generated shell scripts explicitly define auto-completion logic for all CLI commands (index, doc, job, profile, query, init, version) and their respective subcommands (create, list, get, delete, etc.).
Flag Auto-Completion: Automatically completes contextual flags (e.g., --file, --model, --wait, --poll-interval, --profile) depending on the current subcommand you are using.
Dynamic Index Name Resolution: Embedded a helper function in both the Bash and Zsh scripts that dynamically fetches your available indexes in the background using moss index list --json. This means commands like moss query or moss doc add will automatically populate with your actual remote index names.
2. CLI Registration (main.py)

Hooked the completions command into the main Typer application.
Registered it alongside commands that do not depend on the Moss SDK (like version), ensuring that users can always generate completion scripts regardless of their local environment setup.
3. Graceful SDK Fallbacks (init_cmd.py & version.py)

Init Command Fallback: Updated the init command so that if the moss_core native binary is missing (which makes the Management API unavailable), it handles the RuntimeError gracefully and saves your credentials without forcing validation, preventing the initialization process from hard crashing.
Version Command Resiliency: Updated version.py so that if the moss package fails to import, it catches the exception and simply reports the SDK version as "unavailable" rather than breaking the entire moss version output.

yatharthk2 · 2026-04-30T22:26:52Z

 ]
 dependencies = [
-    "moss>=1.0.0",
+    "moss==1.0.0",


why pin moss ?

yatharthk2 · 2026-04-30T22:43:48Z

+    except RuntimeError as e:
+        if "moss_core" in str(e) and "not available" in str(e):
+            pass  # management API unavailable; save without validation
+        else:
+            console.print(f"[red]Authentication failed: {e}[/red]")
+            save_anyway = Prompt.ask("Save anyway?", choices=["y", "n"], default="n")
+            if save_anyway != "y":
+                raise typer.Exit(1)


Why is this exception necessary ?

yatharthk2 · 2026-04-30T22:47:37Z

 def version_command(ctx: typer.Context) -> None:
    """Print CLI and SDK version information."""
    import moss_cli
-    import moss
+
+    try:
+        import moss
+        sdk_version = moss.__version__
+    except Exception:
+        sdk_version = "unavailable"

    json_mode = ctx.obj.get("json_output", False)

    if json_mode:
        import json

-        print(json.dumps({"cli": moss_cli.__version__, "sdk": moss.__version__}))
+        print(json.dumps({"cli": moss_cli.__version__, "sdk": sdk_version}))
    else:
        console.print(f"moss-cli  {moss_cli.__version__}")
-        console.print(f"moss SDK  {moss.__version__}")
+        console.print(f"moss SDK  {sdk_version}")


Please try to keep the change as relevant and minimal as possible.

devin-ai-integration

Devin Review found 1 new potential issue.

View 4 additional findings in Devin Review.

devin-ai-integration · 2026-05-03T05:53:00Z

+    except Exception:
+        pass  # moss SDK unavailable; SDK-dependent commands will be absent


🔴 Overly broad except Exception silently swallows non-import errors during command registration

The except Exception: pass block at main.py:44-45 is intended to catch ImportError when the moss SDK is not installed, but it catches all exceptions. If any of the SDK-dependent command modules (doc.py, index.py, init_cmd.py, job.py, search.py) have a runtime error at import time or during registration (e.g., AttributeError, TypeError, NameError, SyntaxError), those errors are silently swallowed. The affected commands simply disappear from the CLI with no warning or error message, making such failures extremely hard to diagnose. Since all five modules only depend on from moss import ... at the top level, catching ImportError (or ModuleNotFoundError) would be sufficient and safe.

Was this helpful? React with 👍 or 👎 to provide feedback.

…and init handler - Revert moss==1.0.0 back to moss>=1.0.0 to allow patch updates - Remove unnecessary RuntimeError handling for moss_core in init command - Remove unnecessary try/except around moss import in version command - Move _register_moss_commands to module level so app is fully populated for tests

devin-ai-integration

Devin Review found 2 new potential issues.

View 2 additional findings in Devin Review.

devin-ai-integration · 2026-05-03T06:05:51Z

    no_args_is_help=True,
 )


🚩 Typer's built-in completion (add_completion=True) coexists with custom completions command

The app = typer.Typer(add_completion=True) at main.py:17 adds Typer's built-in --install-completion and --show-completion global options. The new completions subcommand provides richer, hand-crafted shell scripts. These don't technically conflict (one is global options, the other a named command), but having two completion mechanisms could confuse users. Consider setting add_completion=False to avoid ambiguity, or document the distinction.

(Refers to lines 17-20)

Was this helpful? React with 👍 or 👎 to provide feedback.

can you please resolve this ? @Sravan1011

devin-ai-integration · 2026-05-03T06:05:53Z

+def _register_moss_commands() -> None:
+    """Import and register commands that require the moss SDK."""
+    from .commands.doc import doc_app
+    from .commands.index import index_app
+    from .commands.init_cmd import init_command
+    from .commands.job import job_app
+    from .commands.search import query_command
+
+    app.add_typer(index_app, name="index", help="Manage indexes")
+    app.add_typer(doc_app, name="doc", help="Manage documents")
+    app.add_typer(job_app, name="job", help="Track background jobs")
+    app.command(name="query")(query_command)
+    app.command(name="init")(init_command)
+
+try:
+    _register_moss_commands()
+except Exception:
+    pass  # moss SDK unavailable; SDK-dependent commands will be absent


🚩 No tests added for new completions command or lazy-loading pattern

The PR adds a new completions_command function and a significant behavioral change (lazy registration of SDK-dependent commands). Neither has accompanying tests. The CONTRIBUTING.md guideline states "If you've added code that should be tested, add tests." While the completions function is simple (echoing static strings), the lazy-loading pattern in main.py is a meaningful behavioral change that would benefit from at least a smoke test verifying commands register correctly and degrade gracefully.

Was this helpful? React with 👍 or 👎 to provide feedback.

Sravan1011 · 2026-05-03T06:12:31Z

@yatharthk2 Sir I have made changes according to the comments I got

…d lazy-loading - Set add_completion=False to avoid duplicate completion mechanisms (Typer built-in vs custom 'moss completions' command) - Add test_completions.py with 7 tests covering: - Bash/Zsh script output - Missing/invalid shell argument errors - SDK-dependent command registration (lazy-loading) - Help text display - Verification that --install-completion/--show-completion are removed Resolves PR usemoss#192 review comments.

Sravan1011 · 2026-05-07T03:51:48Z

@yatharthk2 updated pr

Sravan1011 and others added 8 commits April 23, 2026 07:55

feat: add moss-connector-mysql source connector (fixes usemoss#169)

a82edfa

Merge branch 'usemoss:main' into main

7c44674

fix: remove PlanetScale from connector.py docstring

ead8932

Merge branch 'usemoss:main' into main

92c96e4

Merge branch 'usemoss:main' into main

8283c96

Merge branch 'usemoss:main' into main

3cecbe8

feat: add shell completions for bash and zsh (fixes usemoss#128)

e83da95

Merge branch 'usemoss:main' into main

57d2a8f

Sravan1011 requested review from CoderOMaster, HarshaNalluru, r4ghu and yatharthk2 as code owners April 30, 2026 12:57

This comment was marked as resolved.

Sign in to view

yatharthk2 reviewed Apr 30, 2026

View reviewed changes

Merge branch 'usemoss:main' into main

0fc27d1

devin-ai-integration Bot reviewed May 3, 2026

View reviewed changes

Sravan1011 and others added 2 commits May 6, 2026 11:56

Merge branch 'usemoss:main' into main

782d7fe

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Shell completions for Bash, Zsh # 128#192

Shell completions for Bash, Zsh # 128#192
Sravan1011 wants to merge 12 commits intousemoss:mainfrom
Sravan1011:main

Sravan1011 commented Apr 30, 2026 •

edited by devin-ai-integration Bot

Loading

Uh oh!

This comment was marked as resolved.

Uh oh!

yatharthk2 Apr 30, 2026

Uh oh!

yatharthk2 Apr 30, 2026

Uh oh!

yatharthk2 Apr 30, 2026

Uh oh!

devin-ai-integration Bot left a comment

Uh oh!

devin-ai-integration Bot May 3, 2026 •

edited

Loading

Uh oh!

devin-ai-integration Bot left a comment

Uh oh!

devin-ai-integration Bot May 3, 2026

Uh oh!

yatharthk2 May 6, 2026

Uh oh!

devin-ai-integration Bot May 3, 2026

Uh oh!

Sravan1011 commented May 3, 2026

Uh oh!

Sravan1011 commented May 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		except Exception:
		pass # moss SDK unavailable; SDK-dependent commands will be absent

Conversation

Sravan1011 commented Apr 30, 2026 • edited by devin-ai-integration Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

yatharthk2 Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

yatharthk2 Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

yatharthk2 Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration Bot May 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration Bot May 3, 2026

Choose a reason for hiding this comment

Uh oh!

yatharthk2 May 6, 2026

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration Bot May 3, 2026

Choose a reason for hiding this comment

Uh oh!

Sravan1011 commented May 3, 2026

Uh oh!

Sravan1011 commented May 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Sravan1011 commented Apr 30, 2026 •

edited by devin-ai-integration Bot

Loading

devin-ai-integration Bot May 3, 2026 •

edited

Loading