test-edirect
Large shell-based demonstration and smoke-test script for Entrez Direct. With no arguments it runs a long sequence of real EDirect examples and prints titled sections such as INFO HELP, FIELD EXAMPLE, and LINK EXAMPLE. It also has a special -test mode that enables tracing around one targeted pipeline.
Quick Start
- Command:
test-edirect - Local executable:
/home/vimalinx/miniforge3/envs/bio/bin/test-edirect - Special modes:
-timer,-timed,-test
When To Use This Tool
- Verifying that a local EDirect installation can execute a broad set of canonical example workflows
- Running a human-readable smoke suite instead of a one-endpoint connectivity probe
- Spot-checking whether
esearch,efetch,elink,xtract, and related helpers all cooperate correctly - Using the focused
-testpath when you want tracing around one smaller pipeline
Common Patterns
# Run the full demonstration / smoke suite
test-edirect
# Add elapsed times between sections
test-edirect -timer
# Run the focused trace-enabled test path
test-edirect -test
Recommended Workflow
- Start with a plain
test-edirectrun when you want a broad installation smoke test. - Use
-timerif you care about rough section timings. - Use
-testwhen you want a much narrower traced pipeline instead of the whole suite. - Treat this tool as a diagnostic/demo harness, not as a stable machine-readable checker.
Guardrails
-hand--versionare not help/version modes; locally both failed withUnrecognized option.- The default no-arg path is long-running and network-dependent. In a bounded local run it began by printing
EDirect 24.0,Linux - x86_64, then section headers likeINFO HELP,FIELD EXAMPLE, andLINK EXAMPLE. - Source inspection shows
-testexportsEDIRECT_TRACE=trueand runs a specificesearch | efilter | elink | xtractpipeline before exiting. - Because the script exercises many live EDirect examples, failures may reflect network issues, remote content drift, or one broken helper anywhere in the chain.