tarantool / tarantool/doc

tt CLI (2.10): improve `tt cat` `tt play` working with directories

Open
#5,450 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.10.0
Dev ticket: https://github.com/tarantool/tt/commit/c63a628e3c197eb346ac0da79368cf25b579ed7a https://jira.vk.team/browse/TNTP-2367
Root document: https://www.tarantool.io/en/doc/latest/tooling/tt_cli/cat/ https://www.tarantool.io/en/doc/latest/tooling/tt_cli/play/

SME: @ oleg-jukovec @ dmyger

Details

This commit improves the functionality of the cat and play commands
in the Tarantool CLI. It allows these commands to work recursively with
directories containing multiple files, enhancing their usability and
flexibility.

Usage Example:

tt cat -r /path/to/directory1 /path/to/directory2
tt play --recursive app:instance001 /path/to/directory1

Closes #TNTP-2367

Also fixed (see changelog): tt cat|play <DIR> with directories handles only .snap or .xlog files

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 with the documentation pages at tooling/tt_cli/cat/ and tooling/tt_cli/play/ and compare them with the described recursive directory behavior. Update the usage and behavior details for directory inputs, including the .snap and .xlog limitation, and verify that the examples match the documented commands.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.