tarantool / tarantool/doc

tt CLI (2.9): `tt list modules` command

Open
#5,069 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tt cli
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Product: tt CLI
Since: tt 2.9.0
Audience/target: all
Dev ticket:
Root document:

SME: @ AlexandrLitkevich @ oleg-jukovec

Details

tt modules list is a new command to show available modules.
It supports extra flags:

  • --version - to show information about module version.
  • --path - to show module executables path.

Usage Example:
Get simple list of modules with description.

tt modules list

Can produce output like:

module1 - Description for module1
module2 - Description for module2

Display modules version with executable entry point.

tt modules list --version --path

Possible output:

1.2.3   module1 - modules/modules1/command.sh
v0.0.1  module2 - modules/modules2/main

Requested by @dmyger in https://github.com/tarantool/tt/commit/3ca9d57636a747beabd53a342e67d1584e46a602.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the referenced tt CLI list page at https://www.tarantool.io/en/doc/latest/reference/tooling/tt_cli/list/ and compare its existing structure with the requested tt modules list examples. Document the command and its --version and --path flags, then verify that the usage and sample output match the issue; no test file is mentioned.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.