Skip to content

Commit b220570

Browse files
author
Fuli Wu
committed
dcmclient 0.4.0 — the turnkey DICOM command-line client
0 parents  commit b220570

19 files changed

Lines changed: 3763 additions & 0 deletions

‎.github/workflows/docs.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: docs
2+
on:
3+
push:
4+
branches: [main]
5+
permissions:
6+
contents: read
7+
pages: write
8+
id-token: write
9+
jobs:
10+
build-deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: actions/setup-python@v5
15+
with:
16+
python-version: "3.12"
17+
- run: pip install -r docs/requirements.txt
18+
- run: mkdocs build --strict
19+
- uses: actions/upload-pages-artifact@v3
20+
with:
21+
path: site
22+
- uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/site/
2+
.DS_Store

‎LGPL-2.1.txt‎

Lines changed: 502 additions & 0 deletions
Large diffs are not rendered by default.

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎NOTICE‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
dcmclient
2+
Copyright (c) 2026 Fuli Wu
3+
4+
Licensed under the Apache License, Version 2.0 (see LICENSE).
5+
6+
dcmclient's high-performance DICOM engine ships as a compiled binary; its
7+
source is maintained separately and is not included in this distribution. The
8+
Apache-2.0 grant covers the dcmclient binary as distributed.
9+
10+
NOT A MEDICAL DEVICE. dcmclient is not a medical device and is not intended or
11+
cleared for clinical, diagnostic, or therapeutic use. Tool outputs are for research and engineering use only; you are solely
12+
responsible for validating any output for your intended use.
13+
14+
THIRD-PARTY SOFTWARE. The binary statically links third-party open-source
15+
libraries (and links the host operating system's zlib/bzip2 dynamically); all
16+
are listed with their notices in THIRD-PARTY-LICENSES. FFmpeg is included under
17+
the GNU LGPL v2.1 (full text in LGPL-2.1.txt) with a §6 relink offer.
18+
19+
TRADEMARKS. "FFmpeg" is a trademark of the FFmpeg project. "DICOM" is a
20+
registered trademark of the National Electrical Manufacturers Association
21+
(NEMA). These names are used only to describe interoperability; dcmclient is not
22+
affiliated with, sponsored by, or endorsed by the FFmpeg project or NEMA.

‎README.md‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# dcmclient
2+
3+
**One static binary, 61 DICOM tools — first-class for people and for agents.** A
4+
complete command-line DICOM toolbox *and* a self-describing MCP/agent surface,
5+
from one tool registry. No SDK, no per-tool glue, no runtime dependencies. It
6+
opens **any DICOM, from any vendor or country** — **every transfer syntax**
7+
(incl. JPEG-XL / HTJ2K most toolchains can't read) and **every character set**
8+
(Japanese / Korean / Chinese multibyte, all ISO 2022) — where strict tools choke.
9+
10+
```console
11+
# drive it yourself
12+
$ dcmclient dcmdump scan.dcm # inspect — one element per line
13+
$ dcmclient dcmconv --to jxl ct.dcm out.dcm # transcode (incl. JPEG-XL / HTJ2K)
14+
$ dcmclient dcmvalidate scan.dcm # IOD conformance check
15+
$ dcmclient search https://pacs.example.com --patient-id 42 --json # query a PACS
16+
17+
# …or hand it to an agent
18+
$ dcmclient mcp # serve every tool to an MCP client over stdio
19+
$ dcmclient manifest # per-tool inputSchema + outputSchema as JSON
20+
```
21+
22+
> **Not a medical device.** Not intended or cleared for clinical or diagnostic
23+
> use — outputs are for research and engineering only.
24+
25+
→ **[Quickstart](https://dcmkit.github.io/dcmclient/quickstart/)** ·
26+
**[Agent integration](https://dcmkit.github.io/dcmclient/agents/)** ·
27+
**[Tool reference](https://dcmkit.github.io/dcmclient/reference/)** (every flag of every tool)
28+
29+
## A complete command-line toolbox
30+
31+
61 tools covering the whole job — inspect, convert, author, extract, edit,
32+
de-identify, validate, and move studies over the network:
33+
34+
```console
35+
# inspect — as text / JSON / XML / SR tree
36+
$ dcmclient dcmdump scan.dcm # one element per line
37+
$ dcmclient dcm2json scan.dcm > scan.json # DICOM JSON (PS3.18)
38+
$ dcmclient dcm2xml scan.dcm > scan.xml # Native DICOM XML (PS3.19)
39+
$ dcmclient dsrdump report.dcm # Structured Report content tree
40+
41+
# convert & transcode — every codec built in (JPEG-2000 / JPEG-LS / RLE / JPEG-XL / HTJ2K)
42+
$ dcmclient dcmconv --to jxl ct.dcm out.dcm
43+
$ dcmclient dcm2nii ct_series/ ct.nii.gz # → NIfTI (--split = one per series)
44+
$ dcmclient dcm2nrrd ct_series/ ct.nrrd # → NRRD (3D Slicer)
45+
$ dcmclient dcm2mha ct_series/ ct.mha # → MetaImage (ITK / nnU-Net)
46+
$ dcmclient pdf2dcm report.pdf out.dcm # wrap a PDF as Encapsulated PDF
47+
48+
# edit / de-identify / validate
49+
$ dcmclient dcmodify scan.dcm -i '(0010,0010)=Anon^Patient'
50+
$ dcmclient dcmdeident study/*.dcm --out-dir deid/ # PS3.15 Annex E
51+
$ dcmclient dcmvalidate scan.dcm # IOD conformance
52+
53+
# networking — DICOMweb (search / pull / push) + DIMSE (echo / store / find / get / move)
54+
$ dcmclient pull https://pacs.example.com --study 1.2.3 -o ./out
55+
$ dcmclient store-scu PACS 11112 ./*.dcm --aec PACS
56+
$ dcmclient find-scu PACS 11112 -S -k QueryRetrieveLevel=SERIES --json
57+
```
58+
59+
Prefer per-tool commands? One symlink gives each its own name — `ln -s dcmclient
60+
dcmdump` makes `dcmdump scan.dcm` work. Full list + every flag in the
61+
**[tool reference](https://dcmkit.github.io/dcmclient/reference/)**.
62+
63+
## A self-describing agent surface
64+
65+
Every tool is declared once in a single registry. That one declaration *is* the
66+
command-line parser, the `manifest` self-description, **and** the `mcp`
67+
`tools/list` reply — so the agent surface can never drift from what the binary
68+
actually does.
69+
70+
- **`mcp`** — a live [Model Context Protocol](https://modelcontextprotocol.io)
71+
server over stdio; any MCP client (Claude Desktop, Claude Code, your own
72+
runtime) discovers and calls all 61 tools with zero per-tool wiring.
73+
- **`manifest`** — each tool's `inputSchema` + `outputSchema` as JSON, ready to
74+
drop into a function-calling tool definition. Filter by `readOnly` /
75+
`network` / `writesFiles` to expose only a safe subset.
76+
- **JSON envelope** — `{tool, ok, exit_code, result, error}` on `--json`;
77+
`stdout` is machine output, `stderr` is human diagnostics; graduated exit
78+
codes separate bad input from runtime failure.
79+
80+
## Install
81+
82+
**Homebrew** (macOS & Linux) — the recommended path:
83+
84+
```console
85+
$ brew install dcmkit/tap/dcmclient
86+
$ dcmclient --help
87+
```
88+
89+
**Direct download** — grab the binary for your platform from the
90+
[releases page](https://github.com/dcmkit/dcmclient/releases) and put it on your
91+
`PATH` (macOS builds are Developer-ID signed & notarized):
92+
93+
```console
94+
# macOS (arm64); swap the asset for your platform:
95+
# dcmclient-macos-arm64 · dcmclient-macos-x86_64
96+
# dcmclient-linux-aarch64 · dcmclient-linux-x86_64 (glibc 2.28+)
97+
$ curl -L -o dcmclient https://github.com/dcmkit/dcmclient/releases/latest/download/dcmclient-macos-arm64
98+
$ install -m 755 dcmclient /usr/local/bin/
99+
$ dcmclient --help
100+
```
101+
102+
**Container** (sandboxed agents / CI) — the binary is the entrypoint:
103+
104+
```console
105+
$ docker run --rm -i ghcr.io/dcmkit/dcmclient mcp # MCP server over stdio
106+
$ docker run --rm -v "$PWD:/work" ghcr.io/dcmkit/dcmclient dcm2json /work/scan.dcm
107+
```
108+
109+
One symlink gives each tool its own name — `ln -s dcmclient dcmdump` makes
110+
`dcmdump scan.dcm` work, with no extra binary to ship.
111+
112+
## Documentation
113+
114+
Full docs — quickstart, agent integration, and the generated tool reference —
115+
at **[dcmkit.github.io/dcmclient](https://dcmkit.github.io/dcmclient/)**.
116+
117+
## License
118+
119+
**Apache-2.0** (see [LICENSE](LICENSE) / [NOTICE](NOTICE)). The DICOM engine
120+
ships as a compiled binary; third-party components linked into it are listed in
121+
[THIRD-PARTY-LICENSES](THIRD-PARTY-LICENSES) — all permissive except **FFmpeg**,
122+
which is included under **LGPL-2.1** with a §6 relink offer.

0 commit comments

Comments
 (0)