Skip to content

Update CLI command names and syntax in README#20

Open
hiba1204 wants to merge 1 commit into
eclipse-tmll:mainfrom
hiba1204:hiba1204-patch-1
Open

Update CLI command names and syntax in README#20
hiba1204 wants to merge 1 commit into
eclipse-tmll:mainfrom
hiba1204:hiba1204-patch-1

Conversation

@hiba1204

Copy link
Copy Markdown

What it does

Fixes outdated CLI command names and usage examples in the README's "CLI Usage" section.

The documented commands no longer match the actual CLI (tmll/mcp/cli.py):

  • tmll_cli.py does not exist as a standalone script, the CLI is invoked via python3 -m tmll.mcp.cli
  • Command names have changed (e.g. detect-anomalies to anomaly)
  • --experiment <UUID> is a positional argument, not a flag
  • --method does not exist on changepoint, it is --methods (plural)
  • --threshold does not exist on idle-resources, it is --cpu-idle-threshold / --memory-idle-threshold / --disk-idle-threshold
  • Added the missing --log-stderr option to the "Options" section

How to test

  1. Install TMLL from source and start a local Trace Server
  2. Run any of the corrected commands shown in the updated README.
  3. Each corrected command was run on a local Trace Compass server (port 8080) using the network-experiment/serverKernel sample trace from the Tracevizlab tutorials, confirming it runs without command not found or unrecognized arguments errors

Follow-ups

N/A

Review checklist

  • As an author, I have thoroughly tested my changes and carefully followed the instructions in this template

Problem: The CLI Usage section documented commands that don't exist (tmll_cli.py, --experiment flag, anomalies/changepoints/analyze-correlation command names, --method on changepoint, --threshold on idle-resources).
Running any of these as written results in "command not found" or "unrecognized arguments" errors.

Solution: Updated all commands to match the actual CLI implementation (tmll/mcp/cli.py). Also added the missing --log-stderr option.

Impact: Users following the README can now run the CLI successfully.

Signed-off-by: Hiba Kadiri <hiba.kadiri@polymtl.ca>
@kavehshahedi kavehshahedi self-requested a review June 29, 2026 15:41

@kavehshahedi kavehshahedi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for the contribution, Hiba!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants