xnatctl

Provides a concise, action-oriented reference for the XNAT CLI.

6|Updated Jan 22, 2026
One-click install
npx skills add https://github.com/rickyltwong/xnatctl --skill xnatctl
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: xnatctl
Source: https://github.com/rickyltwong/xnatctl/tree/main
Command: npx skills add https://github.com/rickyltwong/xnatctl --skill xnatctl

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

The xnatctl cheat sheet provides a concise, action-oriented reference to the XNAT CLI to reduce time spent searching docs and to accelerate day-to-day tasks.

Core Features & Use Cases

  • Resource-centric commands: quick mapping of common workflows across projects, subjects, sessions, scans, and resources.
  • Profile-based configuration: guidance for switching between servers and default projects to streamline scripting.
  • Admin & API shortcuts: fast entry points for recurring tasks like refreshing catalogs and issuing raw API calls.
  • Quick troubleshooting: pointer to typical issues and recovery steps to keep operations moving.

Quick Start

Use this guide to draft commands for common tasks and quickly generate a ready-to-run sequence for listing projects and downloading a session.

Frequently Asked Questions about xnatctl

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I download and upload neuroimaging sessions using the XNAT CLI?

You can download and upload neuroimaging sessions using XNAT CLI commands by referencing the resource-centric mappings for subjects, sessions, and scans to generate ready-to-run sequences for data transfers.

How do I configure XNAT CLI profiles to switch between servers and default projects?

XNAT CLI profile-based configuration allows switching between servers and default projects by setting up dedicated profiles, streamlining your scripting workflows across different XNAT environments.

What XNAT CLI commands are available for admin tasks like refreshing catalogs and raw API calls?

XNAT CLI admin and API shortcuts provide fast entry points for recurring tasks like refreshing catalogs and issuing raw API calls, accelerating day-to-day project management operations.

What are common XNAT CLI troubleshooting steps for typical issues during data transfers?

XNAT CLI troubleshooting steps point to typical issues and recovery steps during data transfers, helping researchers and admins quickly resolve errors and keep operations moving.

Can I use the XNAT CLI cheat sheet to list projects and draft commands for common workflows?

The XNAT CLI cheat sheet helps you draft commands for common workflows by providing quick mapping across projects, subjects, sessions, scans, and resources to quickly generate a sequence for listing projects.