mobile-dev-inc/maestro

Add a new `maestro doctor` command

Open

#1,785 opened on Jul 10, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Kotlin (6,111 stars) (306 forks)batch import
P3enhancementgood first issuemaestro cli

Description

Use case

Aim: improve quality of issues we get on GitHub, by giving our users a simple way to gather environment information we need to triage bugs.

Inspired by flutter doctor.

Proposal

Introduce a new maestro doctor command. Usage idea:

$ maestro doctor
Doctor summary (to see all details, run flutter doctor -v):
• Maestro CLI v1.36.0 [installed with Homebrew]
• Mac OS X, 14.5, aarch64
• OpenJDK (openjdk 11.0.23 stable, 3.22.0, on macOS 14.5 23F79 darwin-arm64, locale en-US)
• Xcode 15.4, Build version 15F31d

How we can obtain the data

  • OS name, version and CPU arch is provided by JRE
  • Java info from java --version
  • Xcode info from xcodebuild --version

notes

  • Homebrew install (or in general: package manager install) vs standalone install - can we detect that?

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Follow up item

When maestro doctor is implemented:

  • update the bug report template to request users to paste output of maestro doctor.
  • update maestro bugreport to open the bug report template, not empty issue

Contributor guide

Tech stack
kotlinjava
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
KotlinJavaGradleShell commands
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the existing CLI command structure in the Maestro codebase, particularly how commands are registered and executed. Look at the `maestro` main entry point and similar commands for patterns. Consider using ProcessBuilder to run `java version` and `xcodebuild version`. Also, review the bug report template linked in the issue for context on what information is needed. Determine how to detect package manager installation (Homebrew vs standalone) by checking common paths or environment variables.