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

Sravan1011 · 2026-05-18T05:47:40Z

This PR implements shell completions for the moss CLI, addressing #128. It introduces a new moss completions command group that generates native tab-completion scripts for Bash and Zsh, greatly improving command discoverability for power users.
It also introduces dynamic index name completion, which queries the Moss API live during tab-completion so users can auto-complete their actual index names.
Fixes #128

Features Added

moss completions bash|zsh: Outputs valid shell completion scripts.
moss completions install: Auto-detects the user's shell and safely installs the completion block to ~/.bashrc or ~/.zshrc.
moss completions show: Prints the script for the current shell without installing.
Dynamic Index Autocompletion: Pressing <TAB> after moss query, moss index get, moss index delete, or any moss doc subcommand will fetch and list available index names using the configured credentials.

Technical Details & Design Decisions

Typer Compatibility: Disabled Typer's hidden --install-completion flags (add_completion=False initially, but reverted to True to preserve Click's env-var processing). We patch the generated Click scripts so their instruction_shell format matches what Typer expects at runtime.
Graceful Degradation: The dynamic complete_index_name callback handles missing credentials and API errors by silently returning an empty list, ensuring tab-completion never errors out or blocks the user's terminal.
Test Coverage: Added 16 new unit tests in test_completions.py covering script generation, installation idempotency, and the dynamic completion callback behavior.

Testing

pytest tests/ (All 40 tests pass)
Manually tested in Bash and Zsh.
[Link to Loom video demonstrating the tab-completion here]

…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

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

Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>

Sravan1011 · 2026-05-30T18:09:13Z

@r4ghu @yatharthk2 can you review this pr

CoderOMaster · 2026-06-09T06:26:55Z

@Sravan1011 can you update your PR for linting fixes? also please attach a 1 min mandatory video showing the working demo

Copilot

Pull request overview

Adds a new moss completions CLI command intended to output Bash/Zsh completion scripts, and adjusts CLI command registration to separate SDK-dependent commands from SDK-independent ones.

Changes:

Introduces moss completions <bash|zsh> that prints shell completion scripts (including dynamic index-name completion via moss index list --json).
Updates the CLI entrypoint to register version, profile, and completions without importing SDK-dependent modules, and conditionally registers the rest.
Adds a new test module covering basic completions output and command registration behavior.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.

File	Description
packages/moss-cli/src/moss_cli/main.py	Registers `completions` and refactors command registration to optionally skip SDK-dependent commands.
packages/moss-cli/src/moss_cli/commands/completions.py	Implements hard-coded Bash/Zsh completion scripts and the `completions` command.
packages/moss-cli/tests/test_completions.py	Adds tests for completions output, help behavior, and conditional command registration.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+from moss_cli.commands.completions import Shell, completions_command
+from moss_cli.main import app


+try:
+    _register_moss_commands()
+except ImportError:
+    pass  # moss SDK unavailable; SDK-dependent commands will be absent


+    esac
+}
+
+_moss


+        query)
+            case "$prev" in
+                --profile|--top-k|-k|--alpha|-a|--filter) ;;
+                *)                                         COMPREPLY=($(compgen -W "$(_moss_index_names) --profile --top-k -k --alpha -a --filter --cloud -c --interactive -i" -- "$cur")) ;;
+            esac
+            ;;
+
+        completions)
+            COMPREPLY=($(compgen -W "bash zsh" -- "$cur"))
+            ;;


+_moss_completions_cmd() {
+    local shells=('bash:Output bash completion script' 'zsh:Output zsh completion script')
+    _describe 'shell' shells
+}


+            case $line[1] in
+                index)       _moss_index ;;
+                doc)         _moss_doc ;;
+                job)         _moss_job ;;
+                profile)     _moss_profile ;;
+                query)       _moss_query ;;
+                completions) _moss_completions_cmd ;;
+            esac


 app = typer.Typer(
    name="moss",
    help="Moss Semantic Search CLI",
-    add_completion=True,
+    add_completion=False,
    no_args_is_help=True,
 )

-# Register subgroups
-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")
+# Register commands that do not depend on the moss SDK
+app.command(name="version")(version_command)
+app.command(name="completions")(completions_command)
 app.add_typer(profile_app, name="profile", help="Manage auth profiles")


devin-ai-integration

Devin Review found 3 new potential issues.

devin-ai-integration · 2026-06-15T10:15:01Z

+#   eval "$(moss completions bash)"
+
+_moss_index_names() {
+    moss index list --json 2>/dev/null | python3 -c "


🔴 _moss_index_names() uses wrong --json flag position, so index name completions always silently fail

The _moss_index_names() helper in both the bash and zsh completion scripts invokes moss index list --json, but --json is a group-level option defined on the top-level @app.callback() (packages/moss-cli/src/moss_cli/main.py:64). Click's MultiCommand has allow_interspersed_args=False, so group-level options must appear before the subcommand name. Running moss index list --json causes Click to pass --json down to the list command, which doesn't recognize it, resulting in "Error: No such option: --json" (exit code 2). Because the script redirects stderr to /dev/null and wraps the Python parser in try/except Exception: pass, this fails silently — the function returns nothing, and tab-completion for index names never works. The correct invocation is moss --json index list. This affects every completion that calls _moss_index_names: index get, index delete, doc add/delete/get, and query.

Suggested change

moss index list --json 2>/dev/null | python3 -c "

moss --json index list 2>/dev/null | python3 -c "

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

devin-ai-integration · 2026-06-15T10:15:02Z

+
+_moss_index_names() {
+    local -a names
+    names=(${(f)"$(moss index list --json 2>/dev/null | python3 -c '


🔴 Zsh _moss_index_names() also uses wrong --json flag position

Same issue as the bash script: the zsh _moss_index_names() function calls moss index list --json but --json must precede the subcommand for Click to parse it as a group-level option. This silently fails because of 2>/dev/null and except Exception: pass, so zsh index name completions never return any results.

Suggested change

names=(${(f)"$(moss index list --json 2>/dev/null | python3 -c '

names=(${(f)"$(moss --json index list 2>/dev/null | python3 -c '

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

devin-ai-integration · 2026-06-15T10:15:04Z

+try:
+    _register_moss_commands()
+except ImportError:
+    pass  # moss SDK unavailable; SDK-dependent commands will be absent


🚩 Bare except ImportError may silently swallow SDK-present-but-broken import failures

The try/except ImportError block at packages/moss-cli/src/moss_cli/main.py:42-45 catches all ImportError exceptions, not just ModuleNotFoundError for the missing moss package. If the SDK is installed but its API changes (e.g., QueryOptions is removed from moss), then from moss import QueryOptions in search.py:13 would raise ImportError, and the entire set of SDK-dependent commands would silently disappear without any warning. Consider catching ModuleNotFoundError instead, or logging a warning when ImportError is caught but moss is importable.

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

Sravan1011 and others added 15 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

Merge branch 'usemoss:main' into main

0fc27d1

Merge branch 'usemoss:main' into main

782d7fe

Merge branch 'usemoss:main' into main

a725b5e

Merge branch 'usemoss:main' into main

32ba300

Merge branch 'usemoss:main' into main

d01976e

Sravan1011 requested review from CoderOMaster, HarshaNalluru, r4ghu and yatharthk2 as code owners May 18, 2026 05:47

This comment was marked as resolved.

Sign in to view

Apply suggestion from @devin-ai-integration[bot]

62ae046

Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>

CoderOMaster removed the request for review from yatharthk2 June 9, 2026 06:26

CoderOMaster requested a review from Copilot June 15, 2026 10:09

Copilot started reviewing on behalf of CoderOMaster June 15, 2026 10:09 View session

Copilot AI reviewed Jun 15, 2026

View reviewed changes

devin-ai-integration Bot reviewed Jun 15, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Shell completions for Bash, Zsh #128#251

Shell completions for Bash, Zsh #128#251
Sravan1011 wants to merge 16 commits into
usemoss:mainfrom
Sravan1011:main

Sravan1011 commented May 18, 2026 •

edited by devin-ai-integration Bot

Loading

Uh oh!

This comment was marked as resolved.

Uh oh!

Sravan1011 commented May 30, 2026

Uh oh!

CoderOMaster commented Jun 9, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

devin-ai-integration Bot left a comment

Uh oh!

devin-ai-integration Bot Jun 15, 2026

Uh oh!

devin-ai-integration Bot Jun 15, 2026

Uh oh!

devin-ai-integration Bot Jun 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		from moss_cli.commands.completions import Shell, completions_command
		from moss_cli.main import app

+                  esac
+              }
+              _moss

	moss index list --json 2>/dev/null \| python3 -c "
	moss --json index list 2>/dev/null \| python3 -c "

	names=(${(f)"$(moss index list --json 2>/dev/null \| python3 -c '
	names=(${(f)"$(moss --json index list 2>/dev/null \| python3 -c '

Conversation

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

Uh oh!

Features Added

Technical Details & Design Decisions

Testing

Uh oh!

This comment was marked as resolved.

Uh oh!

Sravan1011 commented May 30, 2026

Uh oh!

CoderOMaster commented Jun 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration Bot Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration Bot Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

devin-ai-integration Bot Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Sravan1011 commented May 18, 2026 •

edited by devin-ai-integration Bot

Loading