Skip to content

Commit 0a30e16

Browse files
fedorovclaude
andcommitted
Trim CLI download section in SKILL.md (v1.6.4)
Reduced inline "Command-Line Download" from ~60 lines to 5; detail already exists in references/cli_guide.md. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 5074ab2 commit 0a30e16

2 files changed

Lines changed: 3 additions & 57 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
1212
- Added version tracking guidance: "what's new in vX" workflow using `series_init_idc_version`/`series_revised_idc_version` in `index`; clarified `prior_versions_index` is for reproducibility only (zero overlap with `index`, column names differ from main index version columns)
1313
- Collapsed five `SeriesInstanceUID` join rows into a single universal-key statement; table now covers only non-obvious join columns
1414
- Removed Installation and Setup section (duplicated the CRITICAL version-check block); folded optional deps into `ModuleNotFoundError` Troubleshooting entry
15+
- Trimmed "Command-Line Download" inline section from ~60 lines to 5; full CLI coverage (`download-from-manifest`, `download-from-selection`, all options) remains in `references/cli_guide.md`
1516

1617
## [1.6.3] - 2026-05-09
1718

SKILL.md

Lines changed: 2 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -506,69 +506,14 @@ To identify files, use the `crdc_instance_uuid` column in queries or read DICOM
506506

507507
### Command-Line Download
508508

509-
The `idc download` command provides command-line access to download functionality without writing Python code. Available after installing `idc-index`.
510-
511-
**Auto-detects input type:** manifest file path, or identifiers (collection_id, PatientID, StudyInstanceUID, SeriesInstanceUID, crdc_series_uuid).
509+
`idc download` is available after installing `idc-index`. Auto-detects input type: collection ID, series UID, or manifest file path.
512510

513511
```bash
514-
# Download entire collection
515512
idc download rider_pilot --download-dir ./data
516-
517-
# Download specific series by UID
518-
idc download "1.3.6.1.4.1.9328.50.1.69736" --download-dir ./data
519-
520-
# Download multiple items (comma-separated)
521-
idc download "tcga_luad,tcga_lusc" --download-dir ./data
522-
523-
# Download from manifest file (auto-detected)
524513
idc download manifest.txt --download-dir ./data
525514
```
526515

527-
**Options:**
528-
529-
| Option | Description |
530-
|--------|-------------|
531-
| `--download-dir` | Output directory (default: current directory) |
532-
| `--dir-template` | Directory hierarchy template (default: `%collection_id/%PatientID/%StudyInstanceUID/%Modality_%SeriesInstanceUID`) |
533-
| `--log-level` | Verbosity: debug, info, warning, error, critical |
534-
535-
**Manifest files:**
536-
537-
Manifest files contain S3 URLs (one per line) and can be:
538-
- Exported from the IDC Portal after cohort selection
539-
- Shared by collaborators for reproducible data access
540-
- Generated programmatically from query results
541-
542-
Format (one S3 URL per line):
543-
```
544-
s3://idc-open-data/cb09464a-c5cc-4428-9339-d7fa87cfe837/*
545-
s3://idc-open-data/88f3990d-bdef-49cd-9b2b-4787767240f2/*
546-
```
547-
548-
**Example: Generate manifest from Python query:**
549-
550-
```python
551-
from idc_index import IDCClient
552-
553-
client = IDCClient()
554-
555-
# Query for series URLs
556-
results = client.sql_query("""
557-
SELECT series_aws_url
558-
FROM index
559-
WHERE collection_id = 'rider_pilot' AND Modality = 'CT'
560-
""")
561-
562-
# Save as manifest file
563-
with open('ct_manifest.txt', 'w') as f:
564-
for url in results['series_aws_url']:
565-
f.write(url + '\n')
566-
```
567-
568-
Then download:
569-
```bash
570-
idc download ct_manifest.txt --download-dir ./ct_data
571-
```
516+
See `references/cli_guide.md` for full options, `idc download-from-manifest` (resume support), and `idc download-from-selection` (filter-based).
572517

573518
### 4. Visualizing IDC Images
574519

0 commit comments

Comments
 (0)