Skip to content

Add Verbose Flag (-v) to 'list' Command for Resource Transparency #1019

@AshokThangavel

Description

@AshokThangavel

Currently, the list command allows users to list installed modules and view descriptions using the -d flag. However, there is no quick way within the shell to see the actual resources (Classes, Packages, Globals, Web Apps) associated with an installed module without manually inspecting the module.xml file

Add a -verbose (alias -v) flag to the list command. The shell should display detailed metadata including the installation path, ObjectScript resources, and dependencies.

Desired Behavior

Command: zpm:USER> list <module-name> -v

Proposed Output:

FHIRServerLogs (irisfsrepolog) 1.0.3
    Description: IrisFSRepoLog
    Root: C:\InterSystems\IRIS\mgr\.modules\USER\irisfsrepolog\1.0.3\
    
    --- Registered Resources ---
    [Package]  FHIR.Log.*
    [Class]    FHIR.Log.Util.Logger
    [Global]   ^FHIR.LogD
    [WebApp]   /api/fhir/logs

    --- Dependencies ---
    [IPM]      fslog (1.0.0), testify (1.0.2)
    [Python]   requests, deeplib

Benefits

  • Auditability: Allows developers to verify the contents of a module directly from the IPM shell.
  • Efficiency: Removes the need to read module.xml.
  • Parity: Brings closer to the user experience of other package managers like pip show -f or npm list.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions