CGI-FR / CGI-FR/RIMO

feat: pipe input and output with cmd rimo analyse

Open
#10 1 comment 0 reactions 1 assignee Claimed by @mathisdrn View on GitHub
documentation enhancement
Dominant language
Go
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

**Issue Description:**
Currently, the Rimo tool provides a convenient way to create statistics. However, there seems to be a missing feature that could enhance the tool's usability further. It would be great if Rimo could support reading input data from the standard input using a special file name, such as `-`, which is a common convention in many command-line tools.

**Feature Request:**
I would like to request the addition of support for using the special file name `-` to read input data from the standard input for the `rimo analyse` command. This would allow users to provide input data directly through standard input, without the need to specify an input directory and input file names explicitly.

**Proposed Behavior:**
When the special file name `-` is used as the `input` argument for the `rimo analyse` command, Rimo should read input data from the standard input stream. This would enable users to pipe or redirect data directly into the tool, making it more versatile and in line with common command-line practices.

**Example:**
```sh
rimo analyse - output_directory
```

**Benefits:**
- Improved usability: Users can input data without the need to create intermediary files.
- Consistency: The use of `-` as a special file name is widely recognized in command-line tools.
- Streamlined workflows: Users can easily integrate Rimo into their pipelines and scripts.

**Implementation Considerations:**
- The tool should detect the use of `-` as a file name specifically for the `input` argument of the `rimo analyse` command.
- When `-` is used as the `input` argument, Rimo should read data from the standard input stream.
- Care should be taken to handle potential conflicts with existing functionality or argument parsing.

**Additional Context:**
This enhancement would align Rimo with best practices for command-line tools and provide users with a more seamless experience when working with input data. It would particularly benefit users who prefer to work with pipelines and automate their workflows.

Thank you for considering this feature request. Please let me know if any further information is required or if there are any suggestions regarding the proposed functionality.

**Environment Information:**
- Rimo version: 0.1.0
- Operating System: linux

**Labels:**
- feature request
- command-line tool
- usability

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.