Lumitrace Help
- Version: 0.4.1
- Help version: 1
- Primary JSON entrypoint:
lumitrace help --format json
- Schema JSON entrypoint:
lumitrace schema --format json
Recommended Flow
- Read
lumitrace help --format json.
- Read
lumitrace schema --format json to understand output structure.
- Run lumitrace with
--collect-mode and optional --max-samples.
- Inspect JSON/HTML/text outputs depending on your task.
AI Usage Tips
- First run with
--collect-mode types to get a compact shape of runtime behavior.
- Then switch to
--collect-mode last for final value inspection on suspicious lines.
- Use
--collect-mode history --max-samples N only when value transitions matter.
- Combine
--range or --git-diff to keep outputs small and focused.
Commands
lumitrace [options] script.rb [ruby_opt]
- Run a Ruby script with Lumitrace enabled.
lumitrace [options] exec CMD [args...]
- Use this for command-style entrypoints (e.g. rails/rspec via binstubs or bundle exec).
lumitrace help [--format text|json]
lumitrace schema [--format text|json]
- Show output schema for each collect mode.
Collect Modes
last: Keep only the last observed value and type counts.
types: Keep only type counts and total hit count.
history: Keep last N sampled values and type counts.
Key Options
--collect-mode (default=”last”; values=last,types,history)
--max-samples (default=3; Used by history mode.)
--json[=PATH] (Emit JSON output.)
--html[=PATH] (Emit HTML output.)
--text[=PATH] (Emit text output.)
--range SPEC (repeatable=true; Restrict instrumentation to file ranges.)
--git-diff[=MODE] (Restrict instrumentation to diff hunks.)
Examples
lumitrace --collect-mode history --max-samples 5 -j app.rb
lumitrace --collect-mode types -h -j app.rb
lumitrace --collect-mode last -j exec bin/rails test
lumitrace help --format json
lumitrace schema --format json