Free, open-source 3D sculpting for Linux, macOS and Windows: dense meshes, remeshing, painting, built-in AI (image/text to 3D), Send to Unreal, game-ready LODs, Gaussian splats and OpenUSD.
C++ 3d3d-sculptingcppdear-imguidigital-sculptingfbxgame-developmentgaussian-splattinggltfimage-to-3dmcpopenglopenusdsculptingtext-to-3dunreal-engine
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Scripting and automation - SculptForge User Guide</title>
<meta name="description" content="Every operation in SculptForge is a named command with parameters. The same commands run from the console inside the app, from script files, from the sculptforge-cli tool on a build farm, from Python, and from AI agents through the Model Context Protocol (MCP). This chapter explains the script langu">
<meta name="theme-color" content="#111114">
<meta name="color-scheme" content="dark">
<link rel="icon" type="image/png" sizes="32x32" href="../img/favicon-32.png?v=7">
<link rel="icon" type="image/png" sizes="64x64" href="../img/favicon-64.png?v=7">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png?v=7">
<link rel="canonical" href="https://sculptforge.app/guide/scripting.html">
<meta property="og:type" content="article">
<meta property="og:title" content="Scripting and automation - SculptForge User Guide">
<meta property="og:description" content="Every operation in SculptForge is a named command with parameters. The same commands run from the console inside the app, from script files, from the sculptforge-cli tool on a build farm, from Python, and from AI agents through the Model Context Protocol (MCP). This chapter explains the script langu">
<meta property="og:image" content="https://sculptforge.app/img/social-preview.png?v=5">
<meta property="og:url" content="https://sculptforge.app/guide/scripting.html">
<link rel="stylesheet" href="../style.css?v=19">
<script src="../motion.js?v=12" defer></script>
<script data-goatcounter="https://sculptforge.goatcounter.com/count" async src="https://gc.zgo.at/count.js"></script>
<script src="search-index.js?v=52" defer></script>
</head>
<body class="guide-page" data-prev="projects.html" data-next="packs-and-macros.html">
<div class="scroll-progress" aria-hidden="true"></div>
<header class="nav">
<div class="wrap nav-inner">
<a class="brand" href="../index.html"><img class="brand-mark" src="../img/bust-mark-44.png" srcset="../img/bust-mark-88.png 2x, ../img/bust-mark-132.png 3x" width="44" height="44" alt=""><span>SculptForge</span></a>
<nav aria-label="Main">
<a href="../index.html#features">Features</a>
<a href="../index.html#demos">Demos</a>
<a href="../brushes.html">Brushes</a>
<a href="index.html" aria-current="page">Guide</a>
<a class="nav-dl" href="../index.html#download">Download</a>
<a class="gh" href="https://discord.gg/gWrYkEmQhH">Discord</a>
<a class="gh" href="https://github.com/islandmed/SculptForge">GitHub</a>
</nav>
</div>
</header>
<div class="wrap guide-layout">
<div class="guide-side">
<button class="toc-toggle" type="button" aria-expanded="false" aria-controls="guide-toc">
<span>Contents</span><span class="toc-current">Scripting and automation</span></button>
<div id="guide-toc" class="toc-panel">
<div class="guide-search" role="search">
<input type="search" id="guide-q" placeholder="Search the guide" aria-label="Search the guide" autocomplete="off">
<div class="search-results" id="guide-results" hidden></div>
</div>
<nav class="toc" aria-label="User guide"><a class="toc-home" href="index.html">Contents</a><p class="toc-group">Getting started</p><ul><li><a href="welcome.html">Welcome to SculptForge</a></li><li><a href="first-sculpt.html">Your first sculpt in 10 minutes</a></li><li><a href="whats-new.html">What's new</a></li><li><a href="quick-tour.html">Quick tour for experienced sculptors</a></li><li><a href="installing.html">Install SculptForge on Windows, macOS and Linux</a></li><li><a href="interface.html">The interface</a></li><li><a href="navigation.html">Navigating the view</a></li></ul><p class="toc-group">Sculpting</p><ul><li><a href="sculpting.html">Sculpting and brushes</a></li><li><a href="brush-lab.html">Brush Lab and sharing brushes</a></li><li><a href="brush-packs.html">Brush packs</a></li><li><a href="masking.html">Masking</a></li><li><a href="face-groups.html">Face Groups and visibility</a></li><li><a href="selection-sets.html">Selection sets and morph targets</a></li><li><a href="parts.html">Parts</a></li><li><a href="linked-duplicates.html">Linked Duplicates</a></li><li><a href="forge-spheres.html">Forge Spheres</a></li><li><a href="tube.html">Tube: draw in 3D space</a></li><li><a href="vertex-paint.html">Vertex Paint and materials</a></li><li><a href="texture-painting.html">Texture painting</a></li><li><a href="uv-editor.html">UV Editor</a></li><li><a href="pbr-painting.html">Material painting (PBR)</a></li><li><a href="fill-layers.html">Fill layers, Mesh Maps and Material Recipes</a></li><li><a href="layers.html">Sculpt layers and blend shapes</a></li><li><a href="facial-shapes.html">Facial shapes and live face</a></li><li><a href="subdivision-levels.html">Subdivision levels</a></li><li><a href="micro-levels.html">Micro levels: hundreds of millions of polygons</a></li><li><a href="dynamic-topology.html">Dynamic topology</a></li><li><a href="timeline.html">Sculpt Timeline and timelapse</a></li><li><a href="gizmo.html">Moving, rotating and posing (Gizmo)</a></li><li><a href="geometry.html">Subdivide, remesh, decimate and LODs</a></li><li><a href="cut.html">Cut: line, lasso, rectangle and polyline</a></li><li><a href="retopology.html">Quad retopology and detail projection</a></li></ul><p class="toc-group">AI and capture</p><ul><li><a href="generate-3d.html">Image and text to 3D</a></li><li><a href="splats.html">Gaussian splats</a></li><li><a href="scan-to-splat.html">Scan an object into a splat</a></li><li><a href="scan-to-sculptable.html">From scan to sculptable mesh</a></li><li><a href="phone-capture.html">Phone capture and AR</a></li></ul><p class="toc-group">Files and pipelines</p><ul><li><a href="baking.html">Baking normal and displacement maps</a></li><li><a href="exporting.html">Exporting, Unreal and Bridge</a></li><li><a href="export-presets.html">Export presets</a></li><li><a href="blender.html">Working with Blender</a></li><li><a href="maya.html">Working with Maya</a></li><li><a href="projects.html">Projects, autosave and snapshots</a></li><li><a href="scripting.html" class="current" aria-current="page">Scripting and automation</a><ul class="toc-sections"><li><a href="#the-script-language">The script language</a></li><li><a href="#the-console">The console</a></li><li><a href="#the-command-palette">The command palette</a></li><li><a href="#commonly-used-commands">Commonly used commands</a></li><li><a href="#sculptforge-cli">sculptforge-cli</a></li><li><a href="#the-sculptforge-app-on-the-command-line">The SculptForge app on the command line</a></li><li><a href="#python">Python</a></li><li><a href="#ai-agents-mcp">AI agents (MCP)</a></li><li><a href="#see-also">See also</a></li></ul></li><li><a href="packs-and-macros.html">Packs and macros</a></li><li><a href="studios.html">SculptForge for studios</a></li><li><a href="security.html">Security overview for IT reviews</a></li></ul><p class="toc-group">Reference</p><ul><li><a href="shortcuts.html">Keyboard and mouse</a></li><li><a href="performance.html">Performance and big meshes</a></li><li><a href="troubleshooting.html">Troubleshooting: tablets, display, crashes and FAQ</a></li><li><a href="glossary.html">Glossary</a></li><li><a href="discord.html">Show SculptForge on Discord</a></li></ul></nav>
</div>
</div>
<main class="guide-main" id="top">
<article class="guide-article">
<h1 id="scripting-and-automation">Scripting and automation</h1>
<p>Every operation in SculptForge is a named command with parameters. The same commands run from the console inside the app, from script files, from the <code>sculptforge-cli</code> tool on a build farm, from Python, and from AI agents through the Model Context Protocol (MCP). This chapter explains the script language, the console, both command-line programs, the Python module and connecting AI tools.</p>
<h2 id="the-script-language">The script language<a class="anchor" href="#the-script-language" aria-label="Link to this section">#</a></h2>
<p>A script is a list of statements. Each statement is a command name followed by <code>name=value</code> parameters:</p>
<div class="code-block"><pre class="code"><code class="language-text">new_sphere subdivisions=5
subdivide levels=1
remesh resolution=256; decimate ratio=0.5 # two statements on one line
export_glb path="My Sculpts/bust.glb"</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>The rules:</p>
<ul>
<li>
Statements are separated by new lines or by <code>;</code>.
</li>
<li>
<code>#</code> starts a comment that runs to the end of the line (outside quotes).
</li>
<li>
Parameters are <code>name=value</code> with no spaces around <code>=</code>.
</li>
<li>
<code>true</code> and <code>false</code> are booleans; numbers are numbers; anything else is text.
</li>
<li>
Put text in double quotes when it contains spaces, <code>;</code>, <code>#</code> or <code>"</code>, or when it must stay text even though it looks like a number. Inside quotes only <code>\"</code> and <code>\\</code> are escapes, so Windows paths such as <code>"C:\Users\me\head.obj"</code> work as written.
</li>
<li>
Colours with a <code>#</code> must be quoted: <code>set_color color="#d9a07a"</code>.
</li>
<li>
Paths are UTF-8. Relative paths are relative to the current folder of the program running the script.
</li>
</ul>
<p>Scripts stop at the first command that fails.</p>
<h2 id="the-console">The console<a class="anchor" href="#the-console" aria-label="Link to this section">#</a></h2>
<p>Press the backtick key (left of <kbd>1</kbd>), or choose <strong>File > Script > Console</strong>, to open the console strip above the bottom shelf. Drag its top edge to resize it.</p>
<figure class="shot"><a href="images/console.jpg" class="zoom"><img src="images/console.jpg" alt="The console showing commands run from the interface and typed by hand" width="1100" height="145" loading="lazy" decoding="async"></a><figcaption>The console showing commands run from the interface and typed by hand</figcaption></figure>
<ul>
<li>
<strong>Every command you run appears in the console as a script line</strong>, whether it came from a button, a shortcut, the command palette or the console itself, followed by its result. Failures show in red with the reason.
</li>
<li>
Type a statement and press <kbd>Enter</kbd> to run it. Several statements separated by <code>;</code> run in order and stop at the first failure.
</li>
<li>
<kbd>Tab</kbd> completes command names, then parameter names. Press <kbd>Tab</kbd> again to list the candidates.
</li>
<li>
<kbd>Up</kbd> and <kbd>Down</kbd> walk through the last 200 lines you typed. The history is kept between sessions.
</li>
<li>
<code>help</code> (or <code>?</code>) lists every command; <code>help remesh</code> explains one command and its parameters.
</li>
<li>
<code>clear</code> empties the log.
</li>
</ul>
<p>The console buttons (also in <strong>File > Script</strong>):</p>
<div class="table-wrap"><table><thead><tr><th>Button</th><th>What it does</th></tr></thead><tbody><tr><td><strong>Run script file...</strong></td><td>Runs a text file of statements (<code>.sfscript</code> or <code>.txt</code>), stopping at the first failure</td></tr><tr><td><strong>Copy session as script</strong></td><td>Puts every command run this session on the clipboard as a script you can save and run again</td></tr><tr><td><strong>Clear console</strong></td><td>Empties the log. The session script is kept</td></tr></tbody></table></div>
<aside class="callout callout-tip"><p><strong>Tip:</strong> To record a macro, work normally, then click <strong>Copy session as script</strong>, paste it into a text file and edit out what you don't need. Run it later with <strong>Run script file...</strong> or <code>sculptforge-cli -f</code>.</p></aside>
<h2 id="the-command-palette">The command palette<a class="anchor" href="#the-command-palette" aria-label="Link to this section">#</a></h2>
<p>Press <kbd>F3</kbd> (or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>, or click <strong>Search</strong> at the top right of the window) to search every command, brush and setting by name. <kbd>Enter</kbd> runs the highlighted entry; <kbd>Shift</kbd>+<kbd>Enter</kbd> opens it in the console so you can add parameters first. Commands that need parameters always open in the console. With an empty search, the palette lists what you used recently. See <a href="interface.html">The interface</a>.</p>
<figure class="shot"><a href="images/command-palette.jpg" class="zoom"><img src="images/command-palette.jpg" alt="The command palette searching for a command" width="605" height="400" loading="lazy" decoding="async"></a><figcaption>The command palette searching for a command</figcaption></figure>
<aside class="callout callout-tip"><p><strong>Tip:</strong> Hold <kbd>Ctrl</kbd>+<kbd>Alt</kbd> and point at a button to see the scripting parameters of the command behind it.</p></aside>
<h2 id="commonly-used-commands">Commonly used commands<a class="anchor" href="#commonly-used-commands" aria-label="Link to this section">#</a></h2>
<p><code>sculptforge-cli --list</code> (or <code>help</code> in the console) prints every command with all its parameters. These are the ones you will use most:</p>
<div class="table-wrap"><table><thead><tr><th>Area</th><th>Command</th><th>Key parameters</th></tr></thead><tbody><tr><td>Scene</td><td><code>new_sphere</code></td><td><code>subdivisions</code> (0 to 8, default 6)</td></tr><tr><td>Scene</td><td><code>new_plane</code></td><td><code>resolution</code> (cells per side, default 128)</td></tr><tr><td>Files</td><td><code>open</code></td><td><code>path</code>: models, projects, splats, Bridge files</td></tr><tr><td>Files</td><td><code>save_project</code></td><td><code>path</code> (default: the current project)</td></tr><tr><td>Files</td><td><code>open_project</code></td><td><code>path</code></td></tr><tr><td>Geometry</td><td><code>subdivide</code></td><td><code>levels</code> (1 to 4, default 1)</td></tr><tr><td>Geometry</td><td><code>remesh</code></td><td><code>resolution</code> (32 to 512, default 200)</td></tr><tr><td>Geometry</td><td><code>decimate</code></td><td><code>ratio</code> (default 0.5) or <code>triangles</code></td></tr><tr><td>Geometry</td><td><code>qremesh</code></td><td><code>target</code> (default 5000), <code>adaptive</code>, <code>keep_groups</code>, <code>detect_edges</code>, <code>use_vertexpaint</code>, <code>symmetry</code>, <code>keep_original</code></td></tr><tr><td>Parts</td><td><code>project_all</code></td><td><code>distance</code> (default 0.02), <code>mean</code>, <code>blur</code>, <code>geometry</code>, <code>vertexpaint</code>, <code>source</code></td></tr><tr><td>Geometry</td><td><code>mesh_info</code></td><td></td></tr><tr><td>Sculpting</td><td><code>stroke</code></td><td><code>points</code> (required), <code>brush</code>, <code>radius</code>, <code>strength</code>, <code>invert</code>, <code>symmetry</code>, <code>radial</code>, <code>radial_axis</code>, <code>local</code></td></tr><tr><td>Brushes</td><td><code>brush_set_alpha</code></td><td><code>name</code> (round, square, noise) or <code>path</code>, <code>invert</code></td></tr><tr><td>Brushes</td><td><code>brush_ai</code></td><td><code>prompt</code> (required), <code>provider</code>, <code>model</code>, <code>endpoint</code></td></tr><tr><td>Brushes</td><td><code>brush_install</code></td><td><code>path</code>, <code>code</code> or <code>json</code></td></tr><tr><td>Brushes</td><td><code>brush_save</code></td><td><code>path</code> (required), <code>name</code></td></tr><tr><td>Layers</td><td><code>layer_add</code></td><td><code>name</code></td></tr><tr><td>Layers</td><td><code>layer_set_weight</code></td><td><code>index</code>, <code>weight</code> (both required)</td></tr><tr><td>Masking</td><td><code>mask_by_cavity</code></td><td><code>strength</code>, <code>threshold</code></td></tr><tr><td>Masking</td><td><code>mask_invert</code>, <code>mask_clear</code>, <code>mask_blur</code>, <code>mask_grow</code></td><td><code>iterations</code> where it applies</td></tr><tr><td>Face Groups</td><td><code>facegroup_auto_by_normals</code></td><td><code>angle</code> (default 30)</td></tr><tr><td>Visibility</td><td><code>isolate_facegroup</code>, <code>hide_facegroup</code></td><td><code>group</code> (required)</td></tr><tr><td>Visibility</td><td><code>show_all</code>, <code>delete_hidden</code></td><td></td></tr><tr><td>Transform</td><td><code>transform</code></td><td><code>translate</code>, <code>rotate</code>, <code>scale</code>, <code>pivot</code>, <code>orient</code>, <code>masked</code>, <code>falloff</code>, <code>symmetry</code>, <code>all</code> (<a href="gizmo.html#scripting">Gizmo</a>)</td></tr><tr><td>Parts</td><td><code>part_append</code></td><td><code>type</code> (sphere, cube, plane) or <code>path</code>, <code>name</code>, <code>size</code></td></tr><tr><td>Parts</td><td><code>part_select</code></td><td><code>index</code> or <code>name</code></td></tr><tr><td>Vertex Paint</td><td><code>set_color</code>, <code>paint_fill</code></td><td><code>color</code>, <code>area</code> (unmasked, masked, all)</td></tr><tr><td>Vertex Paint</td><td><code>paint_from_cavity</code></td><td><code>color</code>, <code>strength</code>, <code>smoothing</code></td></tr><tr><td>AI</td><td><code>image_to_3d</code></td><td><code>path</code> (required), <code>service</code>, <code>model</code>, <code>remesh</code>, <code>resolution</code></td></tr><tr><td>AI</td><td><code>text_to_3d</code></td><td><code>prompt</code> (required), <code>service</code>, <code>model</code></td></tr><tr><td>Export</td><td><code>export_glb</code>, <code>export_usd</code>, <code>export_stl</code>, <code>export_ply</code></td><td><code>path</code> (required); <code>export_stl</code> also <code>height_mm</code>, <code>scale</code>, <code>z_up</code></td></tr><tr><td>Export</td><td><code>export_fbx</code></td><td><code>path</code> (required), <code>lods</code>, <code>ratio</code>, <code>scale</code></td></tr><tr><td>Export</td><td><code>export_lods</code></td><td><code>path</code> (required), <code>levels</code>, <code>ratio</code></td></tr><tr><td>Unreal</td><td><code>unreal_send</code></td><td><code>destination</code>, <code>height_cm</code>, <code>lods</code>, <code>network</code></td></tr><tr><td>Splats</td><td><code>splat_to_mesh</code> (Make sculptable)</td><td><code>detail</code>, <code>preset</code>, <code>color</code>, <code>crop</code>, <code>face_guides</code>, <code>stage</code></td></tr><tr><td>Splats</td><td><code>face_guides</code></td><td><code>landmarks</code>, <code>front</code>, <code>up</code>, <code>target</code></td></tr><tr><td>Edit</td><td><code>undo</code>, <code>redo</code></td><td></td></tr></tbody></table></div>
<p>A few commands exist only inside the app, because they change the view rather than the model: <code>set_material</code> (<code>name=</code> a Lit Sphere such as Sculpt, or Studio) and <code>new_cube</code>.</p>
<h2 id="sculptforge-cli">sculptforge-cli<a class="anchor" href="#sculptforge-cli" aria-label="Link to this section">#</a></h2>
<p><code>sculptforge-cli</code> runs commands without a window: on a server, a render farm node or in a build pipeline. It keeps one scene for the whole run, loads your brush library (and studio brushes), and uses the same <code>ai.json</code> settings as the app.</p>
<div class="code-block"><pre class="code"><code class="language-text">sculptforge-cli [options]
-c, --command "<script>" Run commands, separated by ';' (can be given several times)
-f, --file <script.txt> Run commands from a file ('-' reads standard input)
--set NAME=VALUE Define a variable; script values written $NAME are replaced
-l, --list List every command and its parameters
--schema Print the commands as LLM tool definitions (JSON)
--mcp Run as an MCP server on standard input and output
-q, --quiet Only print errors
-h, --help Show this help</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>Each command prints its result on one line (<code>export_glb: Exported out/rock.glb</code>). The exit status is 0 when everything succeeded, 1 for a usage or script syntax error, and 2 when a command failed (the error names the line and the command).</p>
<p>Variables make one script reusable. A value written <code>$NAME</code> (the whole value) is replaced with the <code>--set</code> value, so paths with spaces stay intact:</p>
<div class="code-block"><pre class="code"><code class="language-sh">cat > lods.sfscript <<'EOF'
open path=$in
remesh resolution=256
export_lods path=$out levels=4 ratio=0.5
EOF
for f in rocks/*.obj; do
sculptforge-cli --set in="$f" --set out="lods/$(basename "$f" .obj).glb" -f lods.sfscript
done</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>More examples:</p>
<div class="code-block"><pre class="code"><code class="language-sh"># Concept art -> sculptable model -> USDZ (free, via Hugging Face)
sculptforge-cli -c 'image_to_3d path=hero.png; export_usd path=hero.usdz'
# Design a brush (free, no key) and save it for the team
sculptforge-cli -c 'brush_ai prompt="weathered stone edges"; brush_save path=stone.sfbrush'
# Cavity dirt on a sculpt, then a coloured PLY
sculptforge-cli -c 'open path=bust.sfproj; paint_from_cavity color="#3a2a20" strength=0.8; export_ply path=bust.ply'</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<aside class="callout callout-warning"><p><strong>Warning:</strong> Without the quotes, <code>#3a2a20</code> would start a comment. In a shell, put the whole script in single quotes so the double quotes reach SculptForge.</p></aside>
<h2 id="the-sculptforge-app-on-the-command-line">The SculptForge app on the command line<a class="anchor" href="#the-sculptforge-app-on-the-command-line" aria-label="Link to this section">#</a></h2>
<p>The desktop app takes a few options too, for renders and start-up scripts:</p>
<div class="table-wrap"><table><thead><tr><th>Option</th><th>What it does</th></tr></thead><tbody><tr><td><code>sculptforge FILE</code></td><td>Opens a model, project, splat capture or image at start-up</td></tr><tr><td><code>--run "<commands>"</code></td><td>Runs commands at start-up</td></tr><tr><td><code>--render out.png</code></td><td>Renders the scene to an image and exits</td></tr><tr><td><code>--turntable N</code></td><td>With <code>--render</code>: N frames around the model (<code>out_000.png</code> ...)</td></tr><tr><td><code>--size WxH</code></td><td>Render size (default 1024x1024)</td></tr><tr><td><code>--view YAW,PITCH</code></td><td>Camera angles in degrees (default -30,-15)</td></tr><tr><td><code>--zoom F</code></td><td>Move the camera F times closer than the framed view</td></tr><tr><td><code>--wireframe</code>, <code>--facegroups</code></td><td>Render with the wireframe or face group colours</td></tr><tr><td><code>--hide-mesh</code></td><td>Render only the Gaussian splats</td></tr><tr><td><code>--fullscreen</code></td><td>Start filling the screen (<kbd>F11</kbd> toggles)</td></tr><tr><td><code>--demo NAME</code>, <code>--record out.mp4</code></td><td>Play a scripted demo, and record it to a video (needs ffmpeg)</td></tr><tr><td><code>--ui-test FILE.sfui</code>, <code>--ui-out DIR</code></td><td>Run an interface test script (for developers)</td></tr></tbody></table></div>
<p>A review sheet for a model, eight frames around it:</p>
<div class="code-block"><pre class="code"><code class="language-sh">sculptforge model.glb --render review/model.png --turntable 8 --size 1024x1024</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>Rendering needs an OpenGL 3.3 capable GPU or software renderer and a display. On a headless Linux node, run it under a virtual display such as Xvfb (<code>xvfb-run sculptforge ...</code>).</p>
<h2 id="python">Python<a class="anchor" href="#python" aria-label="Link to this section">#</a></h2>
<p>SculptForge has a Python module, <code>sculptforge</code>, with the same commands plus NumPy access to the mesh. It is included in the VFX Reference Platform builds and the Rez package (see <a href="studios.html">For studios</a>); when building from source, configure CMake with <code>-DSCULPTFORGE_BUILD_PYTHON=ON</code>.</p>
<div class="code-block"><pre class="code"><code class="language-python">import sculptforge as sf
doc = sf.Document() # loads your brush library, like the app
sf.run(doc, "open", path="/show/troll/troll_base.fbx")
sf.run(doc, "remesh", resolution=320)
sf.run_script(doc, "decimate ratio=0.25; export_lods path=/out/troll.glb levels=4")
verts, tris = doc.vertices, doc.triangles # NumPy (N, 3) float32 and (M, 3) uint32
doc.set_mesh(verts * 1.1, tris) # bring in a mesh from your own tools (clears undo)
print(doc.parts) # [{'name': ..., 'visible': ..., 'triangles': ...}]
doc.active_part = "Helmet" # select by index or name
for name, weight in doc.layers: # sculpt layers (blend shapes)
print(name, weight)
print([c["name"] for c in sf.commands()]) # every command with its parameters</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<div class="table-wrap"><table><thead><tr><th>Function or property</th><th>What it does</th></tr></thead><tbody><tr><td><code>sf.run(doc, command, **params)</code></td><td>Runs one command and returns its message</td></tr><tr><td><code>sf.run_script(doc, script)</code></td><td>Runs a script in the syntax above and returns the messages</td></tr><tr><td><code>sf.commands()</code></td><td>Lists every command with its parameters</td></tr><tr><td><code>sf.tool_schema()</code></td><td>The commands as LLM tool definitions (JSON)</td></tr><tr><td><code>doc.vertices</code>, <code>doc.base_vertices</code>, <code>doc.normals</code>, <code>doc.triangles</code></td><td>Mesh arrays of the active Part (copies)</td></tr><tr><td><code>doc.mask</code>, <code>doc.colors</code>, <code>doc.facegroups</code>, <code>doc.hidden</code></td><td>Attribute arrays you can read and assign (<code>None</code> if absent)</td></tr><tr><td><code>doc.layers</code>, <code>doc.layer_delta(i)</code></td><td>Sculpt layers as <code>(name, weight)</code> and their per-vertex offsets</td></tr><tr><td><code>doc.parts</code>, <code>doc.active_part</code></td><td>The Parts list and the active Part</td></tr><tr><td><code>doc.splat_count</code></td><td>Number of loaded Gaussian splats</td></tr></tbody></table></div>
<p>Failures raise <code>sculptforge.CommandError</code>. Long operations release the GIL, so you can run them on worker threads.</p>
<h2 id="ai-agents-mcp">AI agents (MCP)<a class="anchor" href="#ai-agents-mcp" aria-label="Link to this section">#</a></h2>
<p>An AI tool (Claude Code, Claude Desktop, Cursor and others) can work in the SculptForge window while you watch. The AI blocks out a starting point and shows you options; you do the art. <strong>Help > Connect an AI tool...</strong> is the guide in the app, on one screen; it is there while AI features are on (<strong>Edit > Preferences > AI</strong>). It says what this section says, in the same words.</p>
<h3 id="connect-an-ai-tool">Connect an AI tool<a class="anchor" href="#connect-an-ai-tool" aria-label="Link to this section">#</a></h3>
<p><strong>1. Pick your tool.</strong> The window shows the exact command or settings for your install, with <strong>Copy</strong>. SculptForge is listed as <code>sculptforge-live</code> and started as <code>sculptforge-cli --mcp --attach</code>, so it sits beside a <code>sculptforge</code> entry you may already have (the headless server, below). Claude Code, in a terminal:</p>
<div class="code-block"><pre class="code"><code class="language-sh">claude mcp add --scope user sculptforge-live -- /path/to/sculptforge-cli --mcp --attach</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>Claude Desktop: add this to its configuration file (<strong>Settings > Developer > Edit Config</strong>), then restart Claude Desktop:</p>
<div class="code-block"><pre class="code"><code class="language-text">{
"mcpServers": {
"sculptforge-live": { "command": "/path/to/sculptforge-cli", "args": ["--mcp", "--attach"] }
}
}</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>Cursor takes the same entry in <code>~/.cursor/mcp.json</code>. For every other tool, use its setup from the table in <a href="#every-other-tool">Every other tool</a> with the name <code>sculptforge-live</code> and the arguments <code>--mcp --attach</code>; the window writes it out for you. Where <code>sculptforge-cli</code> is on your system: <a href="#where-sculptforge-cli-is">Where sculptforge-cli is</a>.</p>
<p><strong>2. Let it work in this window.</strong> Turn on <strong>Let AI tools control this window</strong>, right there in the window's step 2 (the same switch as in <strong>Edit > Preferences > AI</strong>). It is off by default, and gone while AI features are off.</p>
<p><strong>3. What happens next.</strong></p>
<ul>
<li>
Ask your AI tool for something (examples below). SculptForge shows <strong>Let an AI tool control this window?</strong> with a 6-digit code: click <strong>Approve</strong>, or tell the AI the code. Approval lasts until it disconnects.
</li>
<li>
While it works, the <strong>AI connected</strong> badge sits at the bottom right. <strong>Disconnect</strong> stops it (also in the command palette: <em>Disconnect AI tool</em>; turning the switch or AI features off disconnects it too).
</li>
<li>
Every step lands in Undo as <strong>AI: ...</strong>, so you can step back.
</li>
<li>
It asks you first (<strong>Allow this AI step?</strong>) before files outside the project, scripts and the network: reading or writing files outside the project folder and the files you picked, overwriting a file, saving over the project, deleting library files, running a macro or script, and anything that uses the network (Generate 3D, AI Brush, the brush gallery). Deny and it is told not to retry. Installing or switching packs and the AI switch itself are never offered.
</li>
<li>
It sees the viewport; what it sees goes to that tool's AI service. <code>viewport_image</code> returns the viewport as you see it, <code>view_turntable</code> the model from 4 to 8 sides in one picture, <code>view_set</code> turns and frames your camera, and <code>stroke_screen</code> draws a brush stroke in screen space. With <code>blockout</code> (a Forge Sphere armature in one call), <code>measure</code> and <code>scene_overview</code> it can look, think and correct.
</li>
</ul>
<p><strong>Try asking:</strong></p>
<ul>
<li>
"Block out a creature head with horns for me to sculpt."
</li>
<li>
"Look at my model from all sides and tell me what to fix."
</li>
<li>
"Make three rock variations I can refine."
</li>
<li>
"Teach me: walk me through sculpting an ear, step by step."
</li>
</ul>
<p>The recipes your AI tool lists as prompts (creature head, stylised bust, game-ready, rock variations, teach me) work here too.</p>
<p>How it is kept safe: the connection is a Unix socket (owner-only, in your runtime folder) or, on Windows, a named pipe only your user account can open; there is no network port. Only one AI tool can be connected at a time, requests are rate limited, and what the tool sends is data: tool names and values, never code to run.</p>
<h3 id="without-a-window-the-headless-server">Without a window: the headless server<a class="anchor" href="#without-a-window-the-headless-server" aria-label="Link to this section">#</a></h3>
<p><code>sculptforge-cli --mcp</code> runs SculptForge as an MCP server with a scene of its own, no window needed: for batch jobs and your own agents. The AI tool gets every command as a tool and works on that scene for the session: it can open files, generate models, sculpt strokes, remesh, paint and export. It starts <code>sculptforge-cli</code> on your computer and talks to it over standard input and output. Nothing listens on the network, and nothing is installed into the AI tool. The setups below use the name <code>sculptforge</code> and <code>--mcp</code>; the Claude Desktop bundle is this server too.</p>
<h3 id="i-have-a-subscription">I have a subscription<a class="anchor" href="#i-have-a-subscription" aria-label="Link to this section">#</a></h3>
<div class="table-wrap"><table><thead><tr><th>Subscription</th><th>Use</th><th>Set up</th></tr></thead><tbody><tr><td>Claude (Pro, Max, Ultra)</td><td>Claude Desktop or Claude Code</td><td>Claude Desktop: install the bundle (below). Claude Code: <code>claude mcp add --scope user sculptforge -- /path/to/sculptforge-cli --mcp</code></td></tr><tr><td>ChatGPT (Plus, Pro, Business, Edu, Enterprise)</td><td>Codex CLI</td><td><code>codex mcp add sculptforge -- /path/to/sculptforge-cli --mcp</code>, then <strong>Sign in with ChatGPT</strong></td></tr><tr><td>Google (free, Google AI Pro, Google AI Ultra)</td><td>Antigravity CLI</td><td>add SculptForge to <code>~/.gemini/config/mcp_config.json</code> (below), then sign in with Google</td></tr><tr><td>Grok / xAI</td><td>Grok Build</td><td><code>grok mcp add sculptforge -- /path/to/sculptforge-cli --mcp</code></td></tr></tbody></table></div>
<ul>
<li>
<strong>Claude</strong>: Claude Code uses your plan when you sign in with your Claude account; if <code>ANTHROPIC_API_KEY</code> is set it uses that key and API billing instead. Claude on the web and on phones can't start programs on your computer.
</li>
<li>
<strong>ChatGPT</strong>: the ChatGPT app only connects to remote (HTTPS) MCP servers. SculptForge doesn't run one, on purpose: nothing of yours listens on the network. Use Codex CLI, or the OpenAI Agents SDK or API below.
</li>
<li>
<strong>Gemini</strong>: since June 2026 personal Google accounts use Antigravity CLI; Gemini CLI is for Gemini Code Assist Standard and Enterprise and for API keys.
</li>
<li>
<strong>Grok</strong>: the Grok app (web, phone, X) can't reach programs on your computer, only public HTTPS servers. Grok Build signs in with your xAI account in the browser (xAI's documentation doesn't say which plans that includes) or takes an xAI API key. The xAI API's own MCP tool is remote-only too; your own code can use the function calling example below (API usage is billed by xAI).
</li>
</ul>
<h3 id="where-sculptforge-cli-is">Where sculptforge-cli is<a class="anchor" href="#where-sculptforge-cli-is" aria-label="Link to this section">#</a></h3>
<div class="table-wrap"><table><thead><tr><th>Install</th><th>Command</th></tr></thead><tbody><tr><td>Windows</td><td><code>C:\Program Files\SculptForge\bin\sculptforge-cli.exe --mcp</code></td></tr><tr><td>macOS</td><td><code>/Applications/SculptForge.app/Contents/MacOS/sculptforge-cli --mcp</code></td></tr><tr><td>Linux .deb, .rpm, AUR</td><td><code>/usr/bin/sculptforge-cli --mcp</code></td></tr><tr><td>AppImage</td><td><code>/path/to/SculptForge.AppImage --cli --mcp</code> (<code>--cli</code> runs the CLI inside the AppImage)</td></tr><tr><td>Flatpak</td><td><code>flatpak run --command=sculptforge-cli org.sculptforge.SculptForge --mcp</code></td></tr></tbody></table></div>
<p>In JSON and TOML files a Windows path is written with doubled backslashes (<code>"C:\\Program Files\\SculptForge\\bin\\sculptforge-cli.exe"</code>). The window does that for you.</p>
<h3 id="claude-desktop-bundle">Claude Desktop bundle<a class="anchor" href="#claude-desktop-bundle" aria-label="Link to this section">#</a></h3>
<p>Download the bundle for your system, then install it in Claude Desktop under <strong>Settings > Extensions > Advanced settings</strong> (<a href="https://support.claude.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop" rel="noopener">Anthropic's guide</a>): <a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-windows-x86_64.mcpb" rel="noopener">Windows</a>, <a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-macos.mcpb" rel="noopener">macOS</a>, <a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-linux-x86_64.mcpb" rel="noopener">Linux x86_64</a>, <a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-linux-arm64.mcpb" rel="noopener">Linux ARM64</a>. It carries its own copy of <code>sculptforge-cli</code>. Or add SculptForge to <code>claude_desktop_config.json</code> (Windows <code>%APPDATA%\Claude\</code>, macOS <code>~/Library/Application Support/Claude/</code>, Linux <code>~/.config/Claude/</code>) and restart:</p>
<div class="code-block"><pre class="code"><code class="language-text">{
"mcpServers": {
"sculptforge": { "command": "/path/to/sculptforge-cli", "args": ["--mcp"] }
}
}</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<h3 id="every-other-tool">Every other tool<a class="anchor" href="#every-other-tool" aria-label="Link to this section">#</a></h3>
<p>Most tools take the same <code>mcpServers</code> entry as Claude Desktop above. Each row links the vendor's page the format is from.</p>
<div class="table-wrap"><table><thead><tr><th>Tool</th><th>Set up</th></tr></thead><tbody><tr><td><a href="https://cursor.com/docs/context/mcp" rel="noopener">Cursor</a></td><td>the <code>mcpServers</code> entry in <code>~/.cursor/mcp.json</code> (or <code>.cursor/mcp.json</code> in a project)</td></tr><tr><td><a href="https://code.visualstudio.com/docs/agent-customization/mcp-servers" rel="noopener">VS Code (Copilot agent mode)</a></td><td><code>code --add-mcp '{"name":"sculptforge","type":"stdio","command":"/path/to/sculptforge-cli","args":["--mcp"]}'</code>, or <strong>MCP: Open User Configuration</strong> and add <code>"servers": {"sculptforge": {"type": "stdio", "command": "...", "args": ["--mcp"]}}</code></td></tr><tr><td><a href="https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers" rel="noopener">Visual Studio</a></td><td>the same <code>servers</code> entry in <code>%USERPROFILE%\.mcp.json</code>; Copilot Chat in Agent mode</td></tr><tr><td><a href="https://www.jetbrains.com/help/ai-assistant/mcp.html" rel="noopener">JetBrains AI Assistant</a></td><td><strong>Settings > Tools > AI Assistant > Model Context Protocol (MCP)</strong>: Add, STDIO, paste the <code>mcpServers</code> entry</td></tr><tr><td><a href="https://zed.dev/docs/ai/mcp" rel="noopener">Zed</a></td><td>in its settings file (<code>zed: open settings file</code>): <code>"context_servers": {"sculptforge": {"command": "...", "args": ["--mcp"]}}</code></td></tr><tr><td><a href="https://docs.devin.ai/cli/extensibility/mcp/configuration" rel="noopener">Windsurf (Devin Local)</a></td><td><code>devin mcp add -s user sculptforge -- /path/to/sculptforge-cli --mcp</code>, or the <code>mcpServers</code> entry in <code>~/.config/devin/mcp_config.json</code> (Windows <code>%APPDATA%\devin\</code>)</td></tr><tr><td><a href="https://github.com/google-gemini/gemini-cli/blob/main/docs/tools/mcp-server.md" rel="noopener">Gemini CLI</a></td><td><code>gemini mcp add --scope user sculptforge /path/to/sculptforge-cli --mcp</code></td></tr><tr><td><a href="https://antigravity.google/docs/mcp/" rel="noopener">Antigravity CLI</a></td><td>the <code>mcpServers</code> entry in <code>~/.gemini/config/mcp_config.json</code></td></tr><tr><td><a href="https://learn.chatgpt.com/docs/extend/mcp" rel="noopener">Codex CLI</a></td><td><code>codex mcp add ...</code> as above, or in <code>~/.codex/config.toml</code>: <code>[mcp_servers.sculptforge]</code>, <code>command = "/path/to/sculptforge-cli"</code>, <code>args = ["--mcp"]</code></td></tr><tr><td><a href="https://docs.x.ai/build/features/mcp-servers" rel="noopener">Grok Build</a></td><td><code>grok mcp add ...</code> as above, or the same TOML table in <code>~/.grok/config.toml</code></td></tr><tr><td><a href="https://docs.github.com/en/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers" rel="noopener">GitHub Copilot CLI</a></td><td><code>copilot mcp add sculptforge -- /path/to/sculptforge-cli --mcp</code></td></tr><tr><td><a href="https://docs.cline.bot/mcp/configuring-mcp-servers" rel="noopener">Cline</a></td><td><code>cline mcp add sculptforge --yes -- /path/to/sculptforge-cli --mcp</code>, or the <code>mcpServers</code> entry under <strong>MCP Servers > Configure</strong></td></tr><tr><td><a href="https://docs.continue.dev/customize/deep-dives/mcp" rel="noopener">Continue</a></td><td>a file in <code>.continue/mcpServers/</code> with <code>mcpServers:</code> <code>- name: SculptForge</code>, <code>type: stdio</code>, <code>command: ...</code>, <code>args: ["--mcp"]</code> (agent mode)</td></tr><tr><td><a href="https://kiro.dev/docs/mcp/configuration/" rel="noopener">Kiro</a></td><td>the <code>mcpServers</code> entry in <code>~/.kiro/settings/mcp.json</code></td></tr><tr><td><a href="https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-config-CLI.html" rel="noopener">Amazon Q Developer CLI</a></td><td><code>q mcp add --name sculptforge --command /path/to/sculptforge-cli --args '["--mcp"]'</code></td></tr><tr><td><a href="https://docs.warp.dev/knowledge-and-collaboration/mcp" rel="noopener">Warp</a></td><td><strong>Settings > Agents > MCP servers > Add</strong>, paste the <code>mcpServers</code> entry</td></tr><tr><td><a href="https://goose-docs.ai/docs/getting-started/using-extensions" rel="noopener">Goose</a></td><td><code>goose configure</code> > Add Extension > Command-Line Extension, or in <code>~/.config/goose/config.yaml</code> under <code>extensions:</code> an entry with <code>type: stdio</code>, <code>cmd: ...</code>, <code>args: ["--mcp"]</code></td></tr><tr><td><a href="https://opencode.ai/docs/mcp-servers/" rel="noopener">opencode</a></td><td>in <code>opencode.json</code>: <code>"mcp": {"sculptforge": {"type": "local", "command": ["/path/to/sculptforge-cli", "--mcp"]}}</code></td></tr><tr><td><a href="https://support.atlassian.com/rovo/docs/connect-to-an-mcp-server-in-rovo-dev-cli/" rel="noopener">Rovo Dev CLI</a></td><td>the <code>mcpServers</code> entry plus <code>"transport": "stdio"</code> in <code>~/.rovodev/mcp.json</code> (<code>acli rovodev mcp</code> opens it)</td></tr><tr><td><a href="https://lmstudio.ai/docs/app/mcp" rel="noopener">LM Studio</a></td><td><strong>Program</strong> tab > <strong>Install > Edit mcp.json</strong>, paste the <code>mcpServers</code> entry</td></tr><tr><td><a href="https://docs.jan.ai/desktop/mcp" rel="noopener">Jan</a></td><td><strong>Settings > MCP Servers > +</strong>: command <code>/path/to/sculptforge-cli</code>, arguments <code>--mcp</code></td></tr></tbody></table></div>
<p>Remote only, so not for SculptForge: the ChatGPT app, the Grok app, and Rovo in Atlassian's web apps (public HTTPS servers added by an admin; use Rovo Dev CLI). The OpenAI and xAI APIs' built-in MCP tools also reach only remote servers: use the Agents SDK or plain function calling below.</p>
<h3 id="using-it">Using it<a class="anchor" href="#using-it" aria-label="Link to this section">#</a></h3>
<p>Ask for something like "make a sphere, remesh it at 128 and export it to ~/Desktop/ball.glb". File paths are on your machine. The headless server works on its own scene; to see the result, open the exported file in SculptForge (or use live mode, above, to watch it work).</p>
<ul>
<li>
<strong>viewport_image</strong> gives the agent a picture of the scene (a clay-shaded view of the visible Parts, any angle) to check each step by eye. Every tool call is one undo step, so the agent can take back what went wrong.
</li>
<li>
<strong>Recipes</strong>: the server offers ready-made prompts that walk an agent through a whole job. In Claude Desktop and other tools that show MCP prompts, pick one from the prompt menu: a creature head from a description, a stylised bust from a reference image, a game-ready asset (retopology, UVs, baked maps and LODs for Unreal or Godot), rock variations, and a step-by-step lesson.
</li>
</ul>
<h3 id="your-own-agent">Your own agent<a class="anchor" href="#your-own-agent" aria-label="Link to this section">#</a></h3>
<p>The <a href="https://openai.github.io/openai-agents-python/mcp/" rel="noopener">OpenAI Agents SDK</a> starts the server itself:</p>
<div class="code-block"><pre class="code"><code class="language-python">import asyncio
from agents import Agent, Runner
from agents.mcp import MCPServerStdio
async def main():
async with MCPServerStdio(name="SculptForge", client_session_timeout_seconds=60,
params={"command": "/path/to/sculptforge-cli", "args": ["--mcp"]}) as sf:
agent = Agent(name="Sculptor", instructions="Use SculptForge's tools.", mcp_servers=[sf])
print((await Runner.run(agent, "Make a sphere, remesh it at 128 and export ball.glb")).final_output)
asyncio.run(main())</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>For plain function calling with any model API, <code>sculptforge-cli --schema</code> prints every tool as JSON (<code>name</code>, <code>description</code>, <code>input_schema</code>: the Claude API takes it as it is). APIs limit how many tools one request may carry, so pick the ones the job needs. This helper turns them into function definitions and runs each call in one SculptForge session (through <code>--mcp</code>, so the scene is kept between calls):</p>
<div class="code-block"><pre class="code"><code class="language-python"># sf_tools.py
import json, subprocess
CLI = "/path/to/sculptforge-cli"
WANTED = {"new_sphere", "remesh", "subdivide", "stroke", "decimate", "mesh_info", "export_glb", "undo"}
TOOLS = [{"type": "function", "name": t["name"], "description": t["description"], "parameters": t["input_schema"]}
for t in json.loads(subprocess.run([CLI, "--schema"], capture_output=True, text=True).stdout)
if t["name"] in WANTED]
_sf = subprocess.Popen([CLI, "--mcp"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, text=True)
def call(name, arguments):
_sf.stdin.write(json.dumps({"jsonrpc": "2.0", "id": 1, "method": "tools/call",
"params": {"name": name, "arguments": arguments}}) + "\n")
_sf.stdin.flush()
return json.loads(_sf.stdout.readline())["result"]["content"][0]["text"]</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p><a href="https://developers.openai.com/api/docs/guides/function-calling" rel="noopener">OpenAI API</a> (Responses API). For the <a href="https://docs.x.ai/docs/guides/function-calling" rel="noopener">xAI API</a> use the same code with <code>OpenAI(api_key=os.environ["XAI_API_KEY"], base_url="https://api.x.ai/v1")</code> and a Grok model:</p>
<div class="code-block"><pre class="code"><code class="language-python">import json
from openai import OpenAI
from sf_tools import TOOLS, call
client = OpenAI()
items = [{"role": "user", "content": "Make a sphere, remesh it at 128 and export it to ball.glb"}]
while True:
r = client.responses.create(model="gpt-6-astra", tools=TOOLS, input=items)
items += r.output
calls = [i for i in r.output if i.type == "function_call"]
if not calls: break
items += [{"type": "function_call_output", "call_id": c.call_id,
"output": call(c.name, json.loads(c.arguments))} for c in calls]
print(r.output_text)</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p><a href="https://aistudio.google.com/docs/function-calling" rel="noopener">Gemini API</a> (the <code>google-genai</code> package):</p>
<div class="code-block"><pre class="code"><code class="language-python">from google import genai
from sf_tools import TOOLS, call
client = genai.Client()
interaction = client.interactions.create(model="gemini-3.8-flash", tools=TOOLS,
input="Make a sphere, remesh it at 128 and export it to ball.glb")
for step in interaction.steps:
if step.type == "function_call":
print(step.name, call(step.name, step.arguments))
# Send each result back as Google's guide shows to let the model continue.</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>Never point a tool at a web app's session or cookies: use each vendor's own app, CLI or API as above.</p>
<h2 id="see-also">See also<a class="anchor" href="#see-also" aria-label="Link to this section">#</a></h2>
<ul>
<li>
<a href="interface.html">The interface</a>: the command palette and Ctrl-hover help
</li>
<li>
<a href="studios.html">For studios</a>: Rez, the VFX builds and farm rendering
</li>
<li>
<a href="generate-3d.html">Image and text to 3D</a> and <a href="exporting.html">Exporting</a>: the commands in context
</li>
<li>
<a href="shortcuts.html">Keyboard and mouse reference</a>
</li>
</ul>
</article>
<nav class="pager" aria-label="Previous and next chapter"><a class="prev" rel="prev" href="projects.html"><span>Previous</span>Projects, autosave and snapshots</a><a class="next" rel="next" href="packs-and-macros.html"><span>Next</span>Packs and macros</a></nav>
<p class="guide-meta fine">Also in the app: <strong>Help > User Guide</strong> (<kbd>Shift</kbd>+<kbd>F1</kbd>).
Found a mistake? <a href="https://github.com/islandmed/SculptForge/edit/main/docs/guide/scripting.md">Edit this page on GitHub</a>.</p>
</main>
<aside class="on-page" aria-label="On this page"><p>On this page</p><ul><li><a href="#the-script-language">The script language</a></li><li><a href="#the-console">The console</a></li><li><a href="#the-command-palette">The command palette</a></li><li><a href="#commonly-used-commands">Commonly used commands</a></li><li><a href="#sculptforge-cli">sculptforge-cli</a></li><li><a href="#the-sculptforge-app-on-the-command-line">The SculptForge app on the command line</a></li><li><a href="#python">Python</a></li><li><a href="#ai-agents-mcp">AI agents (MCP)</a></li><li><a href="#see-also">See also</a></li></ul></aside>
</div>
<footer class="footer">
<div class="wrap footer-grid">
<div>
<a class="brand" href="../index.html"><img class="brand-mark" src="../img/bust-mark-44.png" srcset="../img/bust-mark-88.png 2x, ../img/bust-mark-132.png 3x" width="32" height="32" alt=""><span>SculptForge</span></a>
<p class="fine">Copyright © 2026 The SculptForge contributors.<br>The SculptForge User Guide is part of
SculptForge, licensed under the <a href="https://github.com/islandmed/SculptForge/blob/main/LICENSE">GNU GPL v3.0 or later</a>.</p>
</div>
<div class="links">
<a href="../performance/">Performance</a>
<a href="index.html">User guide</a>
<a href="../supporters.html">Members</a>
<a href="https://github.com/islandmed/SculptForge">Source code</a>
<a href="https://discord.gg/gWrYkEmQhH">Community Discord</a>
<a href="https://github.com/islandmed/SculptForge/issues">Report a problem</a>
<a href="https://github.com/islandmed/SculptForge/blob/main/docs/ai-services.md">AI services & privacy</a>
</div>
<p class="fine trademarks">SculptForge is an independent project. Product names are trademarks of their respective owners.</p>
</div>
</footer>
</body>
</html>