Skip to content

[sui][cli] Add support for shell completion in CLI using clap_complete#24469

Merged
stefan-mysten merged 1 commit intoMystenLabs:mainfrom
awnion:main
Feb 3, 2026
Merged

[sui][cli] Add support for shell completion in CLI using clap_complete#24469
stefan-mysten merged 1 commit intoMystenLabs:mainfrom
awnion:main

Conversation

@awnion
Copy link
Copy Markdown
Contributor

@awnion awnion commented Nov 29, 2025 •
edited by stefan-mysten
Loading

Description

feat: Add support for shell completion in CLI using clap_complete

Test plan

Tested by hands yet on ZSH

Need help with testing all the targets

sui completion --generate bash
sui completion --generate elvish
sui completion --generate fish
sui completion --generate powershell
sui completion --generate zsh

Release notes

  • Protocol:
  • Nodes (Validators and Full nodes):
  • gRPC:
  • JSON-RPC:
  • GraphQL:
  • CLI: Sui CLI now supports auto-complete via clap-complete.
sui completion --generate bash
sui completion --generate elvish
sui completion --generate fish
sui completion --generate powershell
sui completion --generate zsh

Put the output in a file in the right directory for your shell (e.g., for fish in ~/.config/fish/completions/sui.fish) and restart your shell. Use double TAB to trigger the auto completion menu.

  • Rust SDK:
  • Indexing Framework:

@vercel
Copy link
Copy Markdown

vercel bot commented Nov 29, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sui-docs Ready Ready Preview, Comment Feb 3, 2026 5:43pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
multisig-toolkit Ignored Ignored Preview Feb 3, 2026 5:43pm
sui-kiosk Ignored Ignored Preview Feb 3, 2026 5:43pm

Request Review

@awnion awnion changed the title feat: Add support for shell completion in CLI using clap_complete [sui][cli] Add support for shell completion in CLI using clap_complete Nov 29, 2025
@awnion awnion marked this pull request as ready for review November 29, 2025 12:52
@awnion
Copy link
Copy Markdown
Contributor Author

awnion commented Nov 29, 2025

related #24297

@kkomelin
Copy link
Copy Markdown
Contributor

kkomelin commented Nov 29, 2025

Nice @awnion. Thank you. Look forward for it to be pushed!

@kkomelin
Copy link
Copy Markdown
Contributor

kkomelin commented Nov 29, 2025

@awnion How can I test it with Bash on Linux?

Cvijan4PointO
Cvijan4PointO reviewed Nov 29, 2025
View reviewed changes
Copy link
Copy Markdown

@Cvijan4PointO Cvijan4PointO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that you did it in a clean and efficient way and I think that this is a good addition to SUI CLI tooling.

@awnion
Copy link
Copy Markdown
Contributor Author

awnion commented Nov 29, 2025

@awnion How can I test it with Bash on Linux?

If you have Rust and Cargo set up, you can generate the completion file from my branch. E.g like this:

  1. Generate the file:

    cargo run --bin sui -- completion --generate bash > /etc/bash_completion.d/sui

    (You might need to run this with sudo since /etc/bash_completion.d/ is a system directory. If you don't have permissions, you can try directing the output to ~/.local/share/bash-completion/completions/sui instead.)

  2. Make it active:
    Once that file is in place, either open a new terminal session or run source ~/.bashrc (or equivalent).

  3. Test it out:
    Type sui (with a space) and hit Tab twice. You should immediately see the list of sui subcommands appear.

Let me know if you run into any issues with the file path!

@kkomelin
Copy link
Copy Markdown
Contributor

kkomelin commented Nov 30, 2025

Tested with docker run --rm -ti ghcr.io/awnion/sui_cli_completions/sui_cli_bash_completions:latest
The autocompletion works fine.

@StefPler StefPler requested review from StefPler and stefan-mysten and removed request for StefPler December 1, 2025 08:14
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 31, 2026

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions github-actions bot added the Stale label Jan 31, 2026
@Cvijan4PointO
Copy link
Copy Markdown

Cvijan4PointO commented Feb 3, 2026

We could use this, autocomplete is always useful, it should not be closed..

@stefan-mysten stefan-mysten self-assigned this Feb 3, 2026
stefan-mysten
stefan-mysten approved these changes Feb 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@stefan-mysten stefan-mysten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I missed this, and thanks for the contribution!

@stefan-mysten stefan-mysten temporarily deployed to sui-typescript-aws-kms-test-env February 3, 2026 17:40 — with GitHub Actions Inactive
@stefan-mysten stefan-mysten merged commit f58ad53 into MystenLabs:main Feb 3, 2026
53 of 59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stefan-mysten stefan-mysten stefan-mysten approved these changes

+1 more reviewer

@Cvijan4PointO Cvijan4PointO Cvijan4PointO left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@stefan-mysten stefan-mysten

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@awnion @kkomelin @Cvijan4PointO @stefan-mysten