pymapdl-cli

Name: pymapdl-cli
Author: ansys

Writing Community

Repo stars 494
Author updated Live
Author repo pymapdl

Fluxly profile Facts only: domain, agents, trust score, runtime, permissions and network

Domain: Writing
Compatible agents: Claude Code
Cursor
Cline
Codex
Windsurf
Gemini CLI

+20
Trust score: 88 / 100 · community maintained
Author / version / license: @ansys · no license declared
Token usage: Lean
Setup complexity: Guided setup
External API key: Not required
Operating systems: macOS · Linux · Windows
Runtime requirements: Python
Permissions: Read-only
Write / modify
Shell exec
Env read
Network behavior: Local-only
Install commands: 26 variants

Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.

Heads up: 未限定 allowed-tools，默认拥有全部工具权限。

Output preview pymapdl-cli-ansys.preview

---
name: pymapdl-cli
description: How to use the PyMAPDL command-line interface to start, stop, list, and execute commands on MAPD…
category: writing
runtime: Python
---

# pymapdl-cli output preview

## PART A: Task fit
- Use case: How to use the PyMAPDL command-line interface to start, stop, list, and execute commands on MAPDL instances from a terminal. Use this skill whenever the user wants to control MAPDL from the command line, run APDL commands via the shell, manage running MAPDL processes, script MAPDL workflows without writing Python, or pipe APDL into a running solver — even if they don't explicitly say "CLI"..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “Commands at a glance / pymapdl start / Key options” and do not present inference as author intent.

## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “How to use the PyMAPDL command-line interface to start, stop, list, and execute commands on MAPDL instances from a terminal. Use this skill whenever the user wants to control MAPDL from the command line, run APDL commands via the shell, manage running MAPDL processes, script MAPDL workflows without writing Python, or pipe APDL into a running solver — even if they don't explicitly say "CLI".”.
- **02** When the source has headings, the agent prioritizes “Commands at a glance / pymapdl start / Key options” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files, run shell commands, read environment variables; mostly runs locally; usually needs no extra API key.

## Running Rules
- read files, write/modify files, run shell commands, read environment variables; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options.

SKILL.md SKILL.md

---
name: pymapdl-cli
description: How to use the PyMAPDL command-line interface to start, stop, list, and execute commands on MAPD…
category: writing
source: ansys/pymapdl
---

# pymapdl-cli

## When to use
- How to use the PyMAPDL command-line interface to start, stop, list, and execute commands on MAPDL instances from a ter…
- Use it when the task has clear inputs, repeatable steps, and validation criteria.

## What to provide
- Target material, scope, expected result, and forbidden changes.
- Whether network, commands, file writes, or external services are allowed.

## Execution rules
- Organize steps around “Commands at a glance / pymapdl start / Key options” and keep inference separate from source facts.
- read files, write/modify files, run shell commands, read environment variables; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding the task.

## Output requirements
- Return the deliverable, key evidence, validation method, and next action.
- Mark missing information as unknown; do not invent commands, platforms, or dependencies.

Evidence boundary and execution chain

The author source anchors workflow facts; repository files anchor sources and commands; Fluxly only adds fit, limitations, and quality judgment.

skill "pymapdl-cli" {
  input      -> user goal + target files + boundaries + acceptance criteria
  context    -> Commands at a glance / pymapdl start / Key options
  rules      -> SKILL.md triggers / order / output contract
  runtime    -> Python | read files, write/modify files, run shell commands, read environment variables | mostly runs locally
  guardrails -> usually needs no extra API key + small-sample validation + diff/log review
  output     -> copyable result + checklist + next iteration
}

Interpretation is structured for decision-making; original keeps the upstream SKILL.md unchanged.

Decide Fit First

Core job: How to use the PyMAPDL command-line interface to start, stop, list, and execute commands on MAPDL instances from a terminal. Use…
Best fit: Use it when the task has reusable inputs, steps, and validation criteria rather than a one-off answer.
Avoid forcing it: If the source lacks commands, platform support, or external-service evidence, keep those fields unknown instead of guessing.

Design Intent

Structure: The skill is organized around “Commands at a glance”, “pymapdl start”, “Key options”, “pymapdl stop”, showing how the author expects the agent to judge fit, collect context, and produce verifiable output.
Trigger evidence: Prioritize the author’s wording around when to use it, what context to collect, and what output shape to produce.
Evidence boundary: Author text states facts, repository files prove commands and paths, and Fluxly only adds fit, limits, and usage judgment.

How To Use It

Inputs: Provide target material, scope, expected result, forbidden changes, and validation method.
Invocation: Name pymapdl-cli directly; if the source includes slash commands, start with the command and then add task context.
Validation: Start small and check whether the result follows “Commands at a glance / pymapdl start / Key options” before expanding.

Boundaries And Review

Dependencies: It usually needs no extra API key, so start with a small validation task.
Permissions: Declared permissions include read / write / shell-exec / env-read; ask the agent to state file, command, and rollback boundaries before acting.
Quality bar: A useful result names the deliverable, evidence, and next action. Generic prose means the task needs tighter context.

PyMAPDL CLI

The pymapdl CLI lets you manage MAPDL instances and execute APDL commands directly from the terminal. It is installed automatically with the ansys-mapdl-core Python package and requires the click dependency (included by default).

A typical session looks like this:

pymapdl start                          # launch a solver instance
pymapdl exec -c /prep7 -c "K,1,0,0,0" # send commands to it
pymapdl exec --file model.inp          # or send a whole script
pymapdl stop                           # shut it down

All commands print human-readable output to stdout and errors to stderr. Exit code is 0 on success, 1 on failure.

Commands at a glance

Command	Purpose
`pymapdl start`	Launch a new local MAPDL instance
`pymapdl stop`	Kill one or all running instances
`pymapdl list`	Show running MAPDL processes
`pymapdl exec`	Send APDL commands to a running instance
`pymapdl convert`	Translate an APDL script to Python

`pymapdl start`

Launch a new MAPDL gRPC server. Prints the IP, port, and PID on success.

pymapdl start [OPTIONS]

Key options

Option	Default	Description
`--port`	50052 (or `PYMAPDL_PORT`)	gRPC port; first available port at or after this value
`--exec_file`	auto-detected	Path to the MAPDL executable
`--run_location`	temp dir	Working directory for the MAPDL process
`--jobname`	`file`	MAPDL jobname
`--nproc`	2	Number of processors
`--ram`	all available	Fixed memory in MB
`--override`	off	Delete stale lock files before starting
`--additional_switches`	none	Extra MAPDL command-line switches (e.g. `aa_r` for academic license)
`--start_timeout`	45	Seconds to wait for the server to become ready
`--license_type`	none	License name (e.g. `meba`, `ansys`) or description (e.g. `enterprise`)
`--version`	latest	MAPDL version to launch (e.g. `241`, `24.1`)

Example — start on a custom port with 4 CPUs:

pymapdl start --port 50055 --nproc 4
# Success: Launched an MAPDL instance (PID=12345) at 127.0.0.1:50055

`pymapdl stop`

Stop running MAPDL instances. By default targets port 50052.

pymapdl stop [OPTIONS]

Options

Option	Description
`--port PORT`	Stop instances listening on this port
`--pid PID`	Stop the process (and its children) with this PID
`--all`	Stop every MAPDL instance on the machine

Examples:

pymapdl stop                  # stop instance on default port 50052
pymapdl stop --port 50055     # stop instance on port 50055
pymapdl stop --pid 12345      # stop a specific process tree
pymapdl stop --all            # stop all MAPDL processes

`pymapdl list`

List MAPDL processes currently running on the machine.

pymapdl list [OPTIONS]

Options

Option	Short	Description
`--instances`	`-i`	Show only parent instances (hide child processes)
`--long`	`-l`	Show all columns (command line + working directory)
`--cmd`	`-c`	Include the command-line column
`--location`	`-cwd`	Include the working-directory column

Example:

pymapdl list -i
# Name          Status    gRPC port    PID
# ANSYS241.exe  running       50052  41644

`pymapdl exec`

Send APDL commands to an already running MAPDL instance and print the solver output. This command never starts a new instance — use pymapdl start first.

pymapdl exec [OPTIONS] [-]

Three input modes (mutually exclusive)

Repeated -c / --command (recommended for scripting and LLM use):
```
pymapdl exec -c /prep7 -c "BLOCK,0,1,0,1,0,1" -c SAVE
```
Each -c value is one APDL command. They are joined with newlines and sent as a single input_strings() block for maximum performance.
File with --file / -f:
```
pymapdl exec --file model.inp
```

Stdin by passing - as a positional argument:

# Linux / macOS
cat model.inp | pymapdl exec -

# Windows PowerShell
Get-Content model.inp | pymapdl exec -

Options

Option	Short	Default	Description
`--command`	`-c`	—	APDL command (repeatable)
`--file`	`-f`	—	Path to an APDL script file
`--port`	—	50052 (or `PYMAPDL_PORT`)	gRPC port of the target instance
`--ip`	—	127.0.0.1 (or `PYMAPDL_IP`)	IP of the target instance
`--timeout`	—	10	Connection timeout in seconds
`--clear-on-connect`	—	off	Clear MAPDL database before sending commands

Behavior notes

Successive calls share state. Because --clear-on-connect is off by default, you can split a workflow across multiple pymapdl exec invocations and the model/mesh/results persist between them.
Output goes to stdout, errors to stderr — ideal for piping, logging, or LLM consumption.
Windows paths are safe. Backslash sequences like C:\new\file are preserved verbatim; no mangling occurs.

`pymapdl convert`

Convert an APDL script to a PyMAPDL Python script.

pymapdl convert [OPTIONS]

Key options

Option	Short	Default	Description
`--file`	`-f`	stdin	APDL input file
`--output`	`-o`	stdout	Output Python file
`--macros_as_functions`	`-mf`	True	Convert macros to Python functions
`--use_function_names`	`-fn`	True	Use method names (`mapdl.k`) instead of `mapdl.run('K')`
`--only_commands`	`-oc`	off	Emit only MAPDL calls (no imports/header/exit)
`--add_imports`	`-ai`	True	Add `launch_mapdl()` boilerplate
`--comment_solve`	`-cs`	off	Comment out SOLVE / /EOF lines

Example:

pymapdl convert -f model.inp -o model.py

Environment variables

Variable	Used by	Purpose
`PYMAPDL_PORT`	`start`, `exec`	Default gRPC port when `--port` is omitted
`PYMAPDL_IP`	`exec`	Default IP when `--ip` is omitted
`PYMAPDL_MAPDL_EXEC`	`start`	Path to MAPDL executable

Common workflows

Interactive modeling session

pymapdl start --port 50055
pymapdl exec --port 50055 -c /prep7
pymapdl exec --port 50055 -c "ET,1,186" -c "BLOCK,0,1,0,1,0,1" -c "VMESH,ALL"
pymapdl exec --port 50055 --file boundary_conditions.inp
pymapdl exec --port 50055 -c /solu -c SOLVE
pymapdl stop --port 50055

Run a full script in one shot

pymapdl start
pymapdl exec --file full_model.inp
pymapdl stop

Pipe commands from another tool

# Generate APDL dynamically and pipe it in
python generate_mesh.py | pymapdl exec -

Fresh database each time

pymapdl exec --clear-on-connect -c /prep7 -c "K,1,0,0,0"

Install command

One-click installPick a runner, click Copy, paste into your terminal, press enter

npx skills add ansys/pymapdl/src/ansys/mapdl/core/skills/pymapdl-cli -y

Open general install guide

View skill source

Works with

Claude Code
Cursor
Cline
Codex
Windsurf
Gemini
OpenCode
Roo Code
AAide
+Augment
GitHub Copilot
OpenClaw
KKiro
Junie
WWarp
Goose
Trae
Kilo Code
OpenHands
Amp
Zencoder
CContinue
AIAider
CodeBuddy
CodeGeeX
Replit Agent

Security audit

88 / 100

Community

未声明 license/许可。
未声明 version。
未限定 allowed-tools，默认拥有全部工具权限。

Metadata

Source: github
ansys/pymapdl
中文

Category & tags

Category Writing

Decide Fit First

Design Intent

How To Use It

Boundaries And Review

PyMAPDL CLI

Commands at a glance

pymapdl start

Key options

pymapdl stop

Options

pymapdl list

Options

pymapdl exec

Three input modes (mutually exclusive)

Options

Behavior notes

pymapdl convert

Key options

Environment variables

Common workflows

Interactive modeling session

Run a full script in one shot

Pipe commands from another tool

Fresh database each time

Discussion

`pymapdl start`

`pymapdl stop`

`pymapdl list`

`pymapdl exec`

`pymapdl convert`