2. Command-line & interactive commands

This page is the complete reference for LatticeMind’s command-line entry points, their flags, and every interactive (slash) command. For a friendlier, task-first introduction see Interactive commands.

2.1. Console commands

The wheel installs these commands on your PATH:

Command	Purpose
latticemind	Start the assistant in the plain CLI. /dashboard on opens the terminal dashboard for the session; LATTICEMIND_UI_MODE=dashboard (or web) chooses an interface at launch.
latticemind-web	Launch the browser-based Web UI directly.

2.2. Shell discovery and one-shot commands

The latticemind command also provides non-interactive commands for shell users and general agents. Add --json or --format json anywhere in a command to receive the versioned JSON response documented in Using LatticeMind from Codex, Claude, and shell agents.

Command	Purpose
latticemind --version	Print the installed LatticeMind version without a license/provider check.
latticemind capabilities --json	Return solvers, shell commands, slash commands, exit codes, and execution safeguards.
latticemind commands [filter] --json	Return the full interactive command catalog or one category/search match.
latticemind docs <question>	Print one concise answer after inferring LatticeMind, RESCU, NanoDCAL, or all corpora from the question.
latticemind docs --list	List packaged LatticeMind manual source paths.
latticemind docs --source <path>	Read one exact packaged LatticeMind manual .rst page.
latticemind protocol --json	Return the versioned runtime protocol manifest.
latticemind doctor --json	Run read-only local and remote-configuration checks.
latticemind project inspect [path] --json	Read project workflow, calculation status, artifact status, and indexed files.
latticemind project ask <question> --project <path> --json	Answer from existing project files and matching LatticeMind manual sections without writing project metadata.
latticemind run <prompt> --json	Run one planning/validation turn; solver execution is disabled by default.
latticemind run <prompt> --execute --approve-execution --json	Run one turn with explicit permission for the validated solver launch.
latticemind run <prompt> --execute --approve-execution --detach	Release the approved calculations and return immediately. See Releasing a long calculation.
latticemind run <prompt> --no-subdir	Work in the current folder instead of creating a project subdirectory. Home, root, system, and software folders still get a subdirectory.
latticemind run <prompt> --solver {rescu,nanodcal,vasp}	Bind a new project to one solver. Left unset, a new project uses RESCU and an existing project keeps the solver it was created with.
latticemind run <prompt> --remote-profile <name>	Execute on the named profile from ~/.latticemind/remote_profiles.toml instead of this machine. See Remote & HPC execution.
latticemind run <prompt> --project <dir> / --new-project	Continue an existing project, or create a new managed project even when the current directory could be attached. A continuation inherits the device, material, and settings of the request the project was founded on.

See Using LatticeMind from Codex, Claude, and shell agents for the recommended Codex/Claude command sequence, JSON fields, exit codes, project continuation, and license/provider setup.

2.3. Releasing a long calculation

A calculation does not need LatticeMind to stay running. Adding --detach releases the approved calculations to run independently — as a Slurm job, an nohup-ed SSH bundle, or a detached local supervisor — and returns immediately:

latticemind run "scf + bs + dos for Si: mp-149" \
    --execute --approve-execution --detach

You can then close the terminal, log out, or shut down the client machine if the work is running remotely. Pick the project up later with:

latticemind run --project <project-dir> "continue"

LatticeMind reattaches to the released work, collects whatever finished while it was away, and carries on from there. Inside the assistant, /status reports what is running and what has completed, and /stale reports steps whose inputs changed and therefore need recomputing.

Released work is tracked through an execution lease recorded inside the project. /lease status shows the lease and whether it still blocks a new launch; if a launch ever reports that it is waiting on a lease you know is finished, /lease clear removes it and the next run proceeds normally. Finished foreground runs leave no lease behind, and a stale lease left by an interrupted session heals automatically on the project’s next run.

This is the recommended way to run anything long — geometry relaxations, phonon dispersions, or large supercells — and the only practical way to use a batch scheduler, where the job may not start until long after you submit it.

Solver documentation searches return excerpts only. --source cannot read an exact RESCU or NanoDCAL page. The wheel contains the sanitized RESCU text corpus and the hand-reviewed NanoDCAL keyword/calculation-name schema; it does not contain the raw mirrors from solver_docs/rst_manual or solver_docs/nanodcal.

docs uses --corpus auto by default. Use --corpus <name> to override the inferred corpus, --json for a compact machine-readable response, and --verbose for full fields on the returned excerpts, including scores, distribution names, and corpus counts. --limit N changes the maximum number of returned excerpts. These commands also bypass the interactive banner and any interface selection when an older installation still maps latticemind to runner.py.

2.4. latticemind-web options

Flag	Meaning
--host <addr>	Bind host. Default: LATTICEMIND_WEB_HOST or 127.0.0.1; cloud mode keeps 127.0.0.1; notebook platforms proxy to it.
--port <n>	Bind port. Default: LATTICEMIND_WEB_PORT or 7865.
--no-open	Do not attempt to open a local browser (use on servers/cloud).
--open-browser	Force opening a local browser.

Example:

latticemind-web --port 7865 --no-open

2.5. Remote utility subcommands

Before opening the interactive app, you can manage remote SSH sessions directly from the shell. These are handled by latticemind at startup:

latticemind remote setup <profile>    # install SSH session-reuse settings
latticemind remote warm <profile>     # open one approved SSH session (2FA once)
latticemind remote status <profile>   # check recorded remote job status
latticemind remote close <profile>    # close the saved SSH session early

See Remote & HPC execution for the full remote/HPC workflow.

2.6. Interactive command palette

Inside any interface, type a command beginning with /. Type /commands (alias /help) to browse them in-app. The full palette:

Help

Command	Description	Example
/commands	Show the command palette (alias /help).	/commands
/help <topic>	Explain a command or topic.	/help execution
/why	Explain the current pause, blocker, or suggested action (alias ?).	/why
/tips	Show context-aware next actions.	/tips
/examples	Show short example prompts.	/examples

Project

Command	Description	Example
/new	Start a fresh managed project.	/new
/projects [limit]	List recent indexed projects.	/projects 8
/resume <project>	Resume a project by id, prefix, or path.	/resume last
/fork <project>	Fork a project before experimenting.	/fork last
/attach .	Adopt the current folder as the active project.	/attach .
/subdir [on|off]	Create a project subdirectory for new work (on, the default) or work in the current folder (off). Alone, report the setting and where the next prompt lands.	/subdir off
/attach-folder <path>	Adopt an existing folder without copying it.	/attach-folder .
/attach <file...>	Attach documents/files to the active or next project.	/attach notes.pdf
/workspace	Inspect the current folder before choosing new/resume/attach.	/workspace
/title <name>	Set a readable display title (alias /rename).	/title Silicon DFPT
/whereami	Show active project, mode, backend, settings (alias /project).	/whereami
/status	Show workflow and calculation status.	/status

Files

Command	Description	Example
/tree	Show key project folders and artifacts.	/tree
/inputs	List known solver input files.	/inputs
/outputs	List known results, plots, logs, and reports.	/outputs

Workflow & validation

Command	Description	Example
/failed	List failed calculation instances and suggested reruns.	/failed
/stale	List stale calculation instances.	/stale
/continue <target>	Continue a failed/stale workflow target.	/continue dfpt_phonon_bs
/rerun <target>	Force a target to rerun.	/rerun band_structure
/validator <on|off>	Enable or skip validation.	/validator on
/readiness	Show launch probability and gate findings.	/readiness
/contract	Show workflow-contract summary.	/contract
/warnings	Show validation/readiness warnings.	/warnings

Execution

Command	Description	Example
/execute <on|off>	Enable or disable solver execution.	/execute on
/approve-for-me <on|off>	Assess each pending action and approve bounded low-risk work; anything else still asks. Hard holds are never bypassed.	/approve-for-me on
/approve-all <on|off>	Approve every gate without asking, except deleting files and cancelling remote work. Hard holds still stop the run. The two modes are exclusive.	/approve-all off
/rescu <command>	Set the RESCU executable or launch command.	/rescu /opt/esapp/rescu
/compute <local|remote|slurm>	Choose local, SSH, or Slurm execution.	/compute slurm
/launch-preview	Preview what would run before launch (alias /dry-run).	/launch-preview
/cost	Estimate resource risk and staged-run recommendations.	/cost
/rescu-plotting [on|off]	Enable or disable RESCU’s built-in plotter (rescu -p); the choice is saved with your settings. Disable it on machines without a MATLAB Java runtime (JVM) — Python post-processing still generates every figure.	/rescu-plotting off
/lease status	Show the recorded execution lease and whether it blocks the next launch (alias /lease).	/lease status
/lease clear	Clear a settled or stale execution lease so the next run launches normally. Refuses to clear a lease whose wave is still running unless given force.	/lease clear

Remote / HPC

Command	Description	Example
/remote wizard	Create or update a remote profile with guided prompts.	/remote wizard
/remote profiles	List remote profiles.	/remote profiles
/remote profile <name>	Select a remote profile.	/remote profile cluster
/remote setup [profile]	Install SSH session-reuse settings.	/remote setup cluster
/remote warm [profile]	Open a reusable SSH session for 2FA.	/remote warm cluster
/remote test [profile]	Run SSH/transfer/scheduler preflight.	/remote test cluster
/remote doctor	Explain remote readiness and next checks.	/remote doctor
/remote status	Check recorded remote job status.	/remote status
/remote fetch	Fetch recorded remote job outputs.	/remote fetch
/remote logs [lines]	Tail latest remote execution logs.	/remote logs 80
/remote workdir	Show remote work directory and local bundle paths.	/remote workdir
/remote cancel	Cancel the recorded remote job.	/remote cancel

Post-processing

Command	Description	Example
/postprocess	Run or preview post-processing scripts.	/postprocess
/plots	List generated plots.	/plots
/analysis	Show the analysis summary.	/analysis

Runtime, cloud & session

Command	Description	Example
/provider [name]	Show the active AI model provider and models, or switch to another (alias /llm).	/provider
/model [id|off]	Show the active model, pin an exact model id, or clear the pin.	/model
/doctor	Read-only environment diagnostics (CLI, web, RESCU, remote).	/doctor
/runtime	Inspect or persist runtime/deployment context.	/runtime
/language <auto|en|fr|zh>	Choose the final report language (alias /report-language).	/language auto
/qbraid	Show the qBraid Web UI and proxy quickstart.	/qbraid
/cloud status	Show cloud/headless web settings.	/cloud status
/web	Launch the Web UI.	/web
/exit	Exit LatticeMind.	/exit

2.7. Environment variables

Every setting also has an environment variable. See Settings & configuration reference for the complete list.