Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add IOTA CLI shell completion docs #4700

Open
lzpap opened this issue Jan 7, 2025 · 1 comment · May be fixed by #4819
Open

Add IOTA CLI shell completion docs #4700

lzpap opened this issue Jan 7, 2025 · 1 comment · May be fixed by #4819
Assignees
@thibault-martinez @DaughterOfMars
Labels
dev-tools Issues related to the Developer Tools Team

Comments

@lzpap
Copy link
Member

lzpap commented Jan 7, 2025

Description

With #4608 the IOTA CLI supports shell completion. The documentation site shall detail how to generate and add completion files given the different shells.

Motivation

Provide better developer experience by more convenient CLI usage.

Requirements

  1. Extend the IOTA CLI doc page with "Shell Completions" subpage.
  2. Detail how to generate/download and install shell completions for the supported shells.
@lzpap lzpap added the dev-tools Issues related to the Developer Tools Team label Jan 7, 2025
@thibault-martinez
Copy link
Member

Do you think we should attach the completions to Github releases?

@thibault-martinez thibault-martinez linked a pull request Jan 16, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thibault-martinez thibault-martinez

@DaughterOfMars DaughterOfMars

Labels
dev-tools Issues related to the Developer Tools Team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

WIP - docs(cli): add completions commands iotaledger/iota
3 participants
@thibault-martinez @DaughterOfMars @lzpap