tarantool / tarantool/doc

tt CLI (2.7): use TT_CLI_MODULES_PATH variable to find modules

Open
#4,687 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.7.0
Root document: ?
SME: @ oleg-jukovec @ dmyger

Details

The TT_CLI_MODULES_PATH environment variable specifies a list of
module's paths separated by a colon “:”.
It can be set externally from tt and must contain a list of
folders where modules are located.
The logic of working with this variable is similar to the PATH
system variable.

Lists of modules are combined into one common list:

  • The modules declared in the configuration file tt.yaml come first
  • then the modules defined via the environment variable are added.
    Any duplicates must be removed, while maintaining the original
    order of module declarations.

Usage example
Set variable:

export TT_CLI_MODULES_PATH=/ext/path/modules:${TT_CLI_MODULES_PATH}

Requested by @dmyger in https://github.com/tarantool/tt/commit/877f3afb136b84b39f86f90df94f43e50b0744be.

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 by locating the tt CLI documentation and the section describing module discovery, using TT_CLI_MODULES_PATH and tt.yaml as search terms. Document the colon-separated environment variable, its ordering and duplicate-removal rules, and the usage example; done means the tt 2.7 behavior is explained clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.