Refactored to scale cli with click library
This commit is contained in:
15
README.md
15
README.md
@@ -36,6 +36,21 @@ From the project root, install the local environment with:
|
||||
poetry install
|
||||
```
|
||||
|
||||
## CLI Help
|
||||
|
||||
To see the available commands and their descriptions, run:
|
||||
|
||||
```powershell
|
||||
poetry run github-datapipe --help
|
||||
```
|
||||
|
||||
To see the available arguments and options for a specific command, use the `--help` flag with that command:
|
||||
|
||||
```powershell
|
||||
poetry run github-datapipe sample-repos --help
|
||||
poetry run github-datapipe fetch-commits --help
|
||||
```
|
||||
|
||||
## Run Phase 1
|
||||
|
||||
The default phase 1 command collects 10 repositories using the default search query from `src/github_datapipe/core/config.py`.
|
||||
|
||||
Reference in New Issue
Block a user