========== orthanc-cli ========== orthanc-cli 0.4.0 Andrii Yurchuk Command-line interface for Orthanc, an open-source, lightweight DICOM server USAGE: orthanc [OPTIONS] FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -s, --server Orthanc server address -u, --username Orthanc username -p, --password Orthanc password SUBCOMMANDS: patient Patient-level commands study Study-level commands series Series-level commands instance Instance-level commands modality Modality-level commands help Prints this message or the help of the given subcommand(s) ========== patient ========== patient Patient-level commands USAGE: patient FLAGS: -h, --help Prints help information -V, --version Prints version information SUBCOMMANDS: list List all patients show Show patient details list-studies List all studies of a patient search Search for patients anonymize Anonymize patient modify Modify patient download Download patient delete Delete patient help Prints this message or the help of the given subcommand(s) ========== list ========== list List all patients USAGE: list [FLAGS] [OPTIONS] FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID PatientName ========== show ========== show Show patient details USAGE: show ARGS: Patient ID FLAGS: -h, --help Prints help information -V, --version Prints version information ========== list-studies ========== list-studies List all studies of a patient USAGE: list-studies [FLAGS] [OPTIONS] ARGS: Patient ID FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID AccessionNumber StudyDate ========== search ========== search Search for patients USAGE: search [FLAGS] [OPTIONS] --query ... FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID PatientName -q, --query ... Search query terms. Space-separted pairs TagName=TagValue. Wildcards are allowed. Example: PatientSex=F PatientName=*Sanchez* ========== anonymize ========== anonymize Anonymize patient USAGE: anonymize [FLAGS] [OPTIONS] ARGS: Patient ID FLAGS: -h, --help Prints help information -p, --keep-private-tags Keep private tags intact -V, --version Prints version information OPTIONS: -c, --config Anonymization configuration file -k, --keep ... DICOM tags that should be kept intact. Space-separated tag names. Example: PatientSex PatientBirthDate -r, --replace ... DICOM tags that should be replaced with the values specified. Space- separted pairs TagName=TagValue. Example: PatientName=REMOVED AccessionNumber=42 ========== modify ========== modify Modify patient USAGE: modify [OPTIONS] ARGS: Patient ID FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -c, --config Modification configuration file -m, --remove ... DICOM tags that should be removed. Space-separated tag names. Example: PatientSex PatientBirthDate -r, --replace ... DICOM tags that should be replaced with the values specified. Space- separted pairs TagName=TagValue. Example: PatientName=REMOVED AccessionNumber=42 ========== download ========== download Download patient USAGE: download --output ARGS: Patient ID FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -o, --output Output file path ========== delete ========== delete Delete patient USAGE: delete ARGS: Patient ID FLAGS: -h, --help Prints help information -V, --version Prints version information ========== help ========== help Prints this message or the help of the given subcommand(s) USAGE: help FLAGS: -h, --help Prints help information -V, --version Prints version information ========== study ========== study Study-level commands USAGE: study FLAGS: -h, --help Prints help information -V, --version Prints version information SUBCOMMANDS: list List all studies show Show study details list-series List all series of a study search Search for studies anonymize Anonymize study modify Modify study download Download study delete Delete study help Prints this message or the help of the given subcommand(s) ========== list ========== list List all studies USAGE: list [FLAGS] [OPTIONS] FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID AccessionNumber StudyDate ========== show ========== show Show study details USAGE: show ARGS: Study ID FLAGS: -h, --help Prints help information -V, --version Prints version information ========== list-series ========== list-series List all series of a study USAGE: list-series [FLAGS] [OPTIONS] ARGS: Study ID FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID Modality BodyPartExamined ========== search ========== search Search for studies USAGE: search [FLAGS] [OPTIONS] --query ... FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID AccessionNumber StudyDate -q, --query ... Search query terms. Space-separted pairs TagName=TagValue. Wildcards are allowed. Example: StudyDescription=*BRAIN* StudyDate=20200101 ========== anonymize ========== anonymize Anonymize study USAGE: anonymize [FLAGS] [OPTIONS] ARGS: Study ID FLAGS: -h, --help Prints help information -p, --keep-private-tags Keep private tags intact -V, --version Prints version information OPTIONS: -c, --config Anonymization configuration file -k, --keep ... DICOM tags that should be kept intact. Space-separated tag names. Example: PatientSex PatientBirthDate -r, --replace ... DICOM tags that should be replaced with the values specified. Space- separted pairs TagName=TagValue. Example: PatientName=REMOVED AccessionNumber=42 ========== modify ========== modify Modify study USAGE: modify [OPTIONS] ARGS: Study ID FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -c, --config Modification configuration file -m, --remove ... DICOM tags that should be removed. Space-separated tag names. Example: PatientSex PatientBirthDate -r, --replace ... DICOM tags that should be replaced with the values specified. Space- separted pairs TagName=TagValue. Example: PatientName=REMOVED AccessionNumber=42 ========== download ========== download Download study USAGE: download --output ARGS: Study ID FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -o, --output Output file path ========== delete ========== delete Delete study USAGE: delete ARGS: Study ID FLAGS: -h, --help Prints help information -V, --version Prints version information ========== help ========== help Prints this message or the help of the given subcommand(s) USAGE: help FLAGS: -h, --help Prints help information -V, --version Prints version information ========== series ========== series Series-level commands USAGE: series FLAGS: -h, --help Prints help information -V, --version Prints version information SUBCOMMANDS: list List all series show Show series details list-instances List all instances of a series search Search for series anonymize Anonymize series modify Modify series download Download series delete Delete series help Prints this message or the help of the given subcommand(s) ========== list ========== list List all series USAGE: list [FLAGS] [OPTIONS] FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID Modality BodyPartExamined ========== show ========== show Show series details USAGE: show ARGS: Series ID FLAGS: -h, --help Prints help information -V, --version Prints version information ========== list-instances ========== list-instances List all instances of a series USAGE: list-instances [FLAGS] [OPTIONS] ARGS: Series ID FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID InstanceCreationDate ========== search ========== search Search for series USAGE: search [FLAGS] [OPTIONS] --query ... FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID Modality BodyPartExamined -q, --query ... Search query terms. Space-separted pairs TagName=TagValue. Wildcards are allowed. Example: SeriesDescription=*BRAIN* SeriesDate=20200101 ========== anonymize ========== anonymize Anonymize series USAGE: anonymize [FLAGS] [OPTIONS] ARGS: Series ID FLAGS: -h, --help Prints help information -p, --keep-private-tags Keep private tags intact -V, --version Prints version information OPTIONS: -c, --config Anonymization configuration file -k, --keep ... DICOM tags that should be kept intact. Space-separated tag names. Example: PatientSex PatientBirthDate -r, --replace ... DICOM tags that should be replaced with the values specified. Space- separted pairs TagName=TagValue. Example: PatientName=REMOVED AccessionNumber=42 ========== modify ========== modify Modify series USAGE: modify [OPTIONS] ARGS: Series ID FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -c, --config Modification configuration file -m, --remove ... DICOM tags that should be removed. Space-separated tag names. Example: PatientSex PatientBirthDate -r, --replace ... DICOM tags that should be replaced with the values specified. Space- separted pairs TagName=TagValue. Example: PatientName=REMOVED AccessionNumber=42 ========== download ========== download Download series USAGE: download --output ARGS: Series ID FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -o, --output Output file path ========== delete ========== delete Delete series USAGE: delete ARGS: Series ID FLAGS: -h, --help Prints help information -V, --version Prints version information ========== help ========== help Prints this message or the help of the given subcommand(s) USAGE: help FLAGS: -h, --help Prints help information -V, --version Prints version information ========== instance ========== instance Instance-level commands USAGE: instance FLAGS: -h, --help Prints help information -V, --version Prints version information SUBCOMMANDS: list List all instances show Show instance details tags Show instance tags search Search for instances anonymize Anonymize instance modify Modify instance download Download instance delete Delete instance help Prints this message or the help of the given subcommand(s) ========== list ========== list List all instances USAGE: list [FLAGS] [OPTIONS] FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID InstanceCreationDate ========== show ========== show Show instance details USAGE: show ARGS: Instance ID FLAGS: -h, --help Prints help information -V, --version Prints version information ========== tags ========== tags Show instance tags USAGE: tags ARGS: Instance ID FLAGS: -h, --help Prints help information -V, --version Prints version information ========== search ========== search Search for instances USAGE: search [FLAGS] [OPTIONS] --query ... FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: ID InstanceCreationDate -q, --query ... Search query terms. Space-separted pairs TagName=TagValue. Wildcards are allowed. Example: InstanceNumber=42 InstanceCreationTime=174242 ========== anonymize ========== anonymize Anonymize instance USAGE: anonymize [FLAGS] [OPTIONS] --output ARGS: Instance ID FLAGS: -h, --help Prints help information -p, --keep-private-tags Keep private tags intact -V, --version Prints version information OPTIONS: -c, --config Anonymization configuration file -k, --keep ... DICOM tags that should be kept intact. Space-separated tag names. Example: PatientSex PatientBirthDate -o, --output Output file path -r, --replace ... DICOM tags that should be replaced with the values specified. Space- separted pairs TagName=TagValue. Example: PatientName=REMOVED AccessionNumber=42 ========== modify ========== modify Modify instance USAGE: modify [OPTIONS] --output ARGS: Instance ID FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -c, --config Modification configuration file -o, --output Output file path -m, --remove ... DICOM tags that should be removed. Space-separated tag names. Example: PatientSex PatientBirthDate -r, --replace ... DICOM tags that should be replaced with the values specified. Space- separted pairs TagName=TagValue. Example: PatientName=REMOVED AccessionNumber=42 ========== download ========== download Download instance USAGE: download --output ARGS: Instance ID FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -o, --output Output file path ========== delete ========== delete Delete instance USAGE: delete ARGS: Instance ID FLAGS: -h, --help Prints help information -V, --version Prints version information ========== help ========== help Prints this message or the help of the given subcommand(s) USAGE: help FLAGS: -h, --help Prints help information -V, --version Prints version information ========== modality ========== modality Modality-level commands USAGE: modality [SUBCOMMAND] FLAGS: -h, --help Prints help information -V, --version Prints version information SUBCOMMANDS: list List all modalities show Show modality details create Create a modality modify Modify a modality echo Send a C-ECHO request to a modality store Send a C-STORE request to a modality delete Delete modality help Prints this message or the help of the given subcommand(s) ========== list ========== list List all modalities USAGE: list [FLAGS] [OPTIONS] FLAGS: -h, --help Prints help information -n, --no-header Don't display table header -V, --version Prints version information OPTIONS: -c, --columns ... Display only the columns specified. Space-separated values. Example: Name Manufacturer ========== show ========== show Show modality details USAGE: show ARGS: Modality name FLAGS: -h, --help Prints help information -V, --version Prints version information ========== create ========== create Create a modality USAGE: create --aet --host --port ARGS: Modality name FLAGS: --help Prints help information -V, --version Prints version information OPTIONS: -a, --aet Modality AET -h, --host Modality host -p, --port Modality port ========== modify ========== modify Modify a modality USAGE: modify --aet --host --port ARGS: Modality name FLAGS: --help Prints help information -V, --version Prints version information OPTIONS: -a, --aet Modality AET -h, --host Modality host -p, --port Modality port ========== echo ========== echo Send a C-ECHO request to a modality USAGE: echo ARGS: Modality name FLAGS: -h, --help Prints help information -V, --version Prints version information ========== store ========== store Send a C-STORE request to a modality USAGE: store --entity-ids ... ARGS: Modality name FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -e, --entity-ids ... Entity IDs ========== delete ========== delete Delete modality USAGE: delete ARGS: Modality name FLAGS: -h, --help Prints help information -V, --version Prints version information ========== help ========== help Prints this message or the help of the given subcommand(s) USAGE: help FLAGS: -h, --help Prints help information -V, --version Prints version information ========== help ========== help Prints this message or the help of the given subcommand(s) USAGE: help FLAGS: -h, --help Prints help information -V, --version Prints version information