The neurodesk CLI
The neurodesk CLI (command-line interface) runs Neurodesktop’s helper tools. Run it in a JupyterLab or desktop terminal as your normal user:
neurodesk --helpTo see the options of one command, add --help, for example
neurodesk cite --help.
Analysis commands
Section titled “Analysis commands”| Command | What it does |
|---|---|
neurodesk cite | Writes a CITATIONS.md file for the Neurodesk tools you loaded. See Generate a citation list. |
neurodesk kernel | Registers the Python inside a tool container as a Jupyter kernel. |
neurodesk uv | Creates a Python environment and kernel for one analysis folder. See Python environments with uv. |
neurodesk jobs | Sends an analysis to a remote Slurm cluster (experimental). See Remote HPC jobs. |
Use a tool container’s Python in a notebook
Section titled “Use a tool container’s Python in a notebook”neurodesk kernel makes a notebook kernel that runs inside a Neurodesk tool
container. Use it when a notebook needs the Python packages that ship with a
tool, such as FSL’s Python:
neurodesk kernel add fsl/6.0.7.16 # or a tool name, for its default versionneurodesk kernel listneurodesk kernel remove fsl/6.0.7.16Refresh JupyterLab, then select the new kernel in the notebook’s kernel menu.
To use another Python that the tool provides, add --python, for example
neurodesk kernel add fsl --python fslpython.
Environment commands
Section titled “Environment commands”| Command | What it does |
|---|---|
neurodesk update | Updates the Neurodesk application menu to the latest tool list. |
neurodesk check | Checks that CVMFS, the GPU, Slurm and T3 remote access work. |
neurodesk info | Shows the image version, CPU and memory limits, free storage, GPUs and the CVMFS server. |
neurodesk test | Runs the test suite that ships with the image. |
neurodesk t3 | Sets up T3 Code remote access through Tailscale. |
Check your environment
Section titled “Check your environment”Run all checks:
neurodesk checkEach check prints PASS, FAIL or SKIP. A check is skipped when the feature
is not in use, for example when there is no NVIDIA GPU. To run some of the
checks, name them:
neurodesk check cvmfsneurodesk check gpu slurm| Check | What it tests |
|---|---|
cvmfs | The Neurodesk CVMFS repository is mounted and lists modules. |
gpu | An NVIDIA GPU is visible. In a desktop terminal, it also tests OpenGL rendering. |
slurm | The Slurm scheduler answers and lists its partitions. |
t3 | T3 Code remote access is set up correctly. |
The command exits with status 1 when a check fails. When you ask for help in
the discussion forum, include
the output of neurodesk info and neurodesk check.
Run the image tests
Section titled “Run the image tests”neurodesk test runs the full test suite in /opt/tests. It takes some time,
and some tests need network access, CVMFS or a running desktop. To run fewer
tests, add pytest options:
neurodesk test -k cvmfs # only tests whose names contain "cvmfs"neurodesk test -x # stop at the first failureCommands for coding agents
Section titled “Commands for coding agents”These commands are for AI coding agents that run analyses in Neurodesktop. The agent guidance in the image tells agents when to use them.
| Command | What it does |
|---|---|
neurodesk agent preflight | Shows the agent guidance revision, Lmod and the Slurm limits before an analysis. |
neurodesk astra | Publishes ASTRA analysis outputs (publish) and checks their recorded software versions (check). |
neurodesk lightcone materialize | Runs a Lightcone materialization on Slurm, outside sbatch. |
Older command names
Section titled “Older command names”Each command was a separate tool before the neurodesk CLI existed. The older names still work, so you do not need to change your scripts.
| Command | Older name |
|---|---|
neurodesk cite | neurodesk-cite |
neurodesk kernel | neurodesk-kernel |
neurodesk uv | neurodesk-uv |
neurodesk jobs | neurodesk-jobs |
neurodesk update | neurodesk-update |
neurodesk check gpu | neurodesktop-gpu-check |
neurodesk t3 | t3_neurodesk_setup |
neurodesk agent preflight | neurodesk-agent-preflight |
neurodesk astra | neurodesk-astra-provenance |
neurodesk lightcone materialize | neurodesk-lc-materialize |