https://github.com/fmotalleb/file_organizer_cli
https://github.com/fmotalleb/file_organizer_cli
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fmotalleb/file_organizer_cli
- Owner: FMotalleb
- License: mit
- Created: 2023-06-30T11:28:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-05T07:31:55.000Z (10 months ago)
- Last Synced: 2025-02-13T04:42:33.010Z (4 months ago)
- Language: Dart
- Size: 43.9 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## file_organizer_cli
![coverage][coverage_badge]
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
[![License: MIT][license_badge]][license_link]
Generated by the [Very Good CLI][very_good_cli_link] 🤖
A Very Good Project created by Very Good CLI..
---
## Getting Started 🚀
If the CLI application is available on [pub](https://pub.dev), activate globally via:
```sh
dart pub global activate file_organizer_cli
```
Or locally via:
```sh
dart pub global activate --source=path
```
## Usage
```sh
# Sample command
$ file_organizer_cli sample
# Sample command option
$ file_organizer_cli sample --cyan
# Show CLI version
$ file_organizer_cli --version
# Show usage help
$ file_organizer_cli --help
```
## Running Tests with coverage 🧪
To run all unit tests use the following command:
```sh
$ dart pub global activate coverage 1.2.0
$ dart test --coverage=coverage
$ dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info
```
To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov)
.
```sh
# Generate Coverage Report
$ genhtml coverage/lcov.info -o coverage/
# Open Coverage Report
$ open coverage/index.html
```
---
[coverage_badge]: coverage_badge.svg
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license_link]: https://opensource.org/licenses/MIT
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli