Skip to main content

CLI usage

This page explains the main workflow steps: Export, Analyze, Excel.

What you will do​

  • Run the app
  • Use Export, Analyze, Excel in the UI
  • Find the output files

Steps​

1) Prepare credentials and config​

Make sure you have:

  • A Firebase Admin service account key (JSON)
  • A participantId

See: Configure the downloader

2) Run the app​

If you are a developer running from source:

macOS and Linux:

./gradlew :composeApp:run

Windows:

./gradlew.bat :composeApp:run

3) Step 1 - Export​

In the app:

  • Select the credentials JSON
  • Enter participantId
  • (Optional) set docRoot and date range
  • Run Export

Export creates one or more *_export*.csv files. See: Output files and folders

4) Step 2 - Analyze​

In the app:

  • Run Analyze

Analyze creates:

  • *_korea_time.csv
  • collection_analysis.csv (coverage report)

5) Step 3 - Excel​

In the app:

  • Run Excel

Excel creates:

  • KoreaTime_ResearcherView.xlsx

See: Excel sheets

6) Review outputs​

Open your participant output folder:

  • macOS and Linux: ~/.datacollection_researcher/output/<participantId>/
  • Windows: %USERPROFILE%\\.datacollection_researcher\\output\\<participantId>\\

7) Logs and errors​

If a step fails:

  • Capture the error message shown in the app
  • If you ran from source, copy the terminal output
  • Share the related output folder and config files (remove secrets)

Common mistakes​

  • Running Analyze before Export (no export CSV exists)
  • Running Excel before Analyze (no _korea_time.csv exists)
  • Moving the credentials JSON after selecting it
  • Leaving participantId blank

Report issues​

Include:

  • Your OS version
  • App version (or git commit if running from source)
  • Which step failed (Export, Analyze, Excel)
  • The exact error message
  • Terminal output (if any)