jyvikoandClaude Opus 5.5
9c65a30265
`cargo xtask kernel-cases [--ladder] --export DIR` runs the rig with the kernel's operations traced (`smlib::trace`) and writes one entry per case: the operation, or chain of operations, that made the bodies the case ends with; each operand that came in as a record, as that record; the parameters, with every pick by points also given as the topology index it picked; the fix set; the case's expected values and the rig's result. A case no kernel operation alone accounts for is written too, marked not expressible with its reasons. DIR/manifest.json counts them per area. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DtL5M41G8Nua7HvuFPZkmJ
1074 lines
59 KiB
Rust
1074 lines
59 KiB
Rust
//! SolidCraft headless command line.
|
|
//!
|
|
//! ```text
|
|
//! solidcraft-cli run <script.json|design.sc|part.step|mesh.3mf> [--in design|part.step|mesh.3mf] [--out FILE]... [--save FILE] [--quiet] [--results] [--timings] [--profile] [--json-out FILE] [--allow-errors]
|
|
//! [--param-check off|warn|strict]
|
|
//! solidcraft-cli eval <script.json|design.sc|part.step> [--in design.sc|part.step] [--json-out FILE] (alias: inspect) measurements as JSON
|
|
//! solidcraft-cli script <design.sc> [--out script.json] the design's history as a command script
|
|
//! solidcraft-cli bench-open <design.sc | part.step> [--parse-only] [--save OUT.sc] [--display LEVEL [--edit NAME EXPR]] [--ops script.json] loading timings as JSON lines
|
|
//! solidcraft-cli bench-agent [--scale F] [--save F] [--script-out F] a ~1,300-body design built command by command, timed
|
|
//! solidcraft-cli bench-assistant --connect 127.0.0.1:PORT [--token T] --base-url URL --model NAME [--tasks 1,2,5] [--repeat N]
|
|
//! [--timeout-s 300] [--json out.json] [--markdown out.md]
|
|
//! the standard Assistant model test (#4851) on a running app
|
|
//! solidcraft-cli snapshot <script|design> [--in design|part.step] --out shot.png [--width W] [--height H] [--view iso|front|top|…|NAME | --camera JSON] [--no-grid] [--no-axes] [--quality LEVEL]
|
|
//! [--body NAME:opacity=0.3,color=#rrggbb]... [--tool NAME]... [--section z=27]
|
|
//! solidcraft-cli exec <command> [json-params] run one command on an empty design
|
|
//! solidcraft-cli commands the command registry as JSON
|
|
//! solidcraft-cli recipe <recipe.json> translate an oracle recipe to a script
|
|
//! solidcraft-cli oracle <case-dir>... replay recipes and compare with expected.json
|
|
//! solidcraft-cli kernel-cases [--json] [--dumps=DIR] [--validation=MODE] <case-dir>... the kernel regression rig (tests/kernel-cases)
|
|
//! solidcraft-cli mcp [--headless] [--in design|script] [--connect HOST:PORT [--token T]] [--allow-path DIR]... [--allow-any-path]
|
|
//! [--param-check off|warn|strict]
|
|
//! MCP server on stdio (docs/mcp.md)
|
|
//! solidcraft-cli mcp setup [--dry-run] [--client NAME] [--live] (alias: mcp install) add it to OpenCode, Claude Desktop, Claude Code, Cursor
|
|
//! solidcraft-cli licences SolidCraft's licence and the third-party licences
|
|
//! solidcraft-cli icon --out F.png|F.ico [--size N] the app icon (packaging; drawn, not a file)
|
|
//!
|
|
//! --debug (with any command) SolidCraft's debug log on stderr (or RUST_LOG=LEVEL)
|
|
//! --max-file-size SIZE (with any command) read STEP and design files up to SIZE (2GB, 1500MB; at most 16GB)
|
|
//! ```
|
|
#![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)]
|
|
#![forbid(unsafe_code)]
|
|
|
|
mod bench_agent;
|
|
mod bench_assistant;
|
|
mod crashes;
|
|
mod fuzz;
|
|
mod kernel_cases;
|
|
mod kernel_cases_export;
|
|
mod logger;
|
|
mod oracle;
|
|
mod preview;
|
|
mod profiling;
|
|
mod recipe;
|
|
mod render;
|
|
mod spatial;
|
|
|
|
use std::process::ExitCode;
|
|
|
|
use serde_json::{Value, json};
|
|
#[path = "../../../assets/icons/app/shared/source/app_icon.rs"]
|
|
mod app_icon;
|
|
|
|
use solidcraft_engine::Session;
|
|
use solidcraft_engine::view::Guides;
|
|
|
|
/// One command the CLI takes: the name to type, the usage it prints for `--help`,
|
|
/// and whether the top-level usage lists it (an alias answers to another command's name).
|
|
struct Command {
|
|
name: &'static str,
|
|
usage: &'static str,
|
|
listed: bool,
|
|
}
|
|
|
|
/// `run`'s lines in the usage.
|
|
const USAGE_RUN: &str = " solidcraft-cli run <script.json|design.sc|part.step> [--in design.sc|part.step] [--out FILE]... [--save FILE] [--quiet] [--results] [--timings] [--profile] [--profile-out trace.json] [--json-out FILE] [--allow-errors] [--validation each_step|each_feature|off]\n [--param-check off|warn|strict]\n solidcraft-cli run --in <design.sc|part.step> [--out FILE]...\n (a timeline feature that fails fails the run and nothing is written; --allow-errors writes anyway)\n (--validation: when SMLib's full check runs on the features computed (diagnostics.validation), default each_feature)\n (--param-check checks each step against its command's contract: warn reports on stderr, strict stops the run)\n (--timings prints {timings: [{index, command, ms}], total_ms} for a script, with --results its results too;\n --profile adds each command's profile: {boolean_ms, tessellate_ms, other_ms}, the kernel's share)\n (--profile also records where the time goes, SMLib's calls, kernel operations, features, commands and import stages,\n and prints the table to stderr: count, total, self time and longest per span; --profile-out FILE writes the spans\n as a Chrome trace for chrome://tracing or ui.perfetto.dev; SOLIDCRAFT_PROFILE=1 does the same for any command)\n";
|
|
/// `eval`'s lines in the usage.
|
|
const USAGE_EVAL: &str = " solidcraft-cli eval <script.json|design.sc|part.step> [--in design.sc|part.step] [--json-out FILE] [--profile] [--profile-out trace.json] (alias: inspect)\n solidcraft-cli eval --in <script.json|design.sc|part.step> [--json-out FILE]\n (with both inputs, runs the positional script on --in before measuring; does not automatically save the modified design)\n (--json-out FILE writes the JSON that run (with --results, else the measurement) and eval print to FILE instead of stdout,\n as plain UTF-8: a shell's > can re-encode it, e.g. Windows PowerShell adds a byte-order mark)\n (--profile and --profile-out as for run)\n";
|
|
/// `script`'s lines in the usage.
|
|
const USAGE_SCRIPT: &str = " solidcraft-cli script <design.sc|script.json> [--out script.json]\n (the design's history as a command script that eval and run replay)\n";
|
|
/// `bench-open`'s lines in the usage.
|
|
const USAGE_BENCH_OPEN: &str = " solidcraft-cli bench-open <design.sc | part.step> [--parse-only] [--save OUT.sc] [--display LEVEL [--edit NAME EXPR]] [--ops script.json] [--profile] [--profile-out trace.json]\n (--profile and --profile-out as for run)\n (--ops: after opening, run each command of the script and undo it, timing the command, the\n evaluations it caused and the view it leaves: placing and meshing what changed)\n";
|
|
/// `bench-agent`'s lines in the usage.
|
|
const USAGE_BENCH_AGENT: &str = " solidcraft-cli bench-agent [--scale F] [--save design.sc] [--script-out script.json]\n";
|
|
/// `bench-assistant`'s lines in the usage.
|
|
const USAGE_BENCH_ASSISTANT: &str = " solidcraft-cli bench-assistant --connect 127.0.0.1:PORT [--token T] --base-url URL --model NAME [--tasks 1,2,5] [--repeat N] [--timeout-s 300] [--json out.json] [--markdown out.md]\n";
|
|
/// `snapshot`'s lines in the usage.
|
|
const USAGE_SNAPSHOT: &str = " solidcraft-cli snapshot <script|design> [--in design.sc|part.step] --out shot.png [--width W] [--height H] [--view NAME | --camera JSON] [--no-grid] [--no-axes]\n [--body NAME:opacity=0.3,color=#rrggbb]... [--tool NAME]... [--section z=27] [--quality coarse|normal|fine|ultra]\n solidcraft-cli snapshot --in <design.sc|part.step> --out shot.png ...\n (as with run, --in starts from a design and the script runs on top of it; an option snapshot doesn't take is an error;\n --view: iso, front, back, top, bottom, left, right, or the name of a view saved in the design with view.save;\n --camera: {target: [x,y,z], yaw, pitch, distance, fov?} in mm and radians, as the MCP screenshot takes it (docs/mcp.md);\n --no-grid and --no-axes leave the ground grid (on Z 0) and the origin's axes out of the picture;\n --body: how one body is drawn, as appearance.assign takes it: opacity 0-1 (below 1 is see-through, so what is inside\n it shows) and color #rrggbb, either or both, once per body;\n --tool: draw this body solid in the tool colour and every other body see-through, so a cut's or a join's tool body\n is visible inside the material it meets; a later --body overrides it;\n --section: cut the model as inspect.section does, so the inside shows: z=27 (the plane through that world\n coordinate, keeping the smaller side), add ,flip to keep the other side, or XY, XZ, YZ, or its own JSON;\n --quality: the display quality the bodies are meshed at, as the app's setting (default normal))\n";
|
|
/// `render`'s lines in the usage.
|
|
const USAGE_RENDER: &str = " solidcraft-cli render <script|design> --out image.png [--setup NAME] [--width W] [--height H] [--transparent] [--overwrite] [--timeout SECONDS]\n [--progressive] [--samples N] [--max-depth N] [--seed N] [--exposure EV] [--lighting FILE.json] [--environment FILE.json] [--tone-map reinhard|aces_fitted]\n";
|
|
/// `exec`'s lines in the usage.
|
|
const USAGE_EXEC: &str = " solidcraft-cli exec <command> [json-params]\n";
|
|
/// `commands`'s lines in the usage.
|
|
const USAGE_COMMANDS: &str = " solidcraft-cli commands\n";
|
|
/// `recipe`'s lines in the usage.
|
|
const USAGE_RECIPE: &str = " solidcraft-cli recipe <recipe.json>\n";
|
|
/// `oracle`'s lines in the usage.
|
|
const USAGE_ORACLE: &str = " solidcraft-cli oracle <case-dir>... [--json]\n";
|
|
/// `kernel-cases`'s lines in the usage.
|
|
const USAGE_KERNEL_CASES: &str = " solidcraft-cli kernel-cases <case-dir>... [--json] [--dumps=DIR] [--export=DIR] [--validation=each_step|each_feature|off]\n (the kernel regression rig, tests/kernel-cases, on SMLib; --dumps: each case's\n failing SMLib calls leave their inputs for replay in DIR/<area>-<case>; --export: each case's\n kernel operations, input records and expected values for solidcore's rig, in DIR/<area>/<case>.json; --validation: when SMLib's\n full check runs (diagnostics.validation), default each_feature)\n";
|
|
/// `fuzz`'s lines in the usage.
|
|
const USAGE_FUZZ: &str =
|
|
" solidcraft-cli fuzz [--from N] [--count N] [--jobs J] [--timeout S] [--steps N] [--minimise] [--out DIR] [--report FILE]\n";
|
|
/// `mcp`'s lines in the usage.
|
|
const USAGE_MCP: &str = " solidcraft-cli mcp [--headless] [--in design.sc|script.json] [--connect 127.0.0.1:PORT [--token T]] [--allow-path DIR]... [--allow-any-path]\n [--param-check off|warn|strict] [--render-gpu]\n solidcraft-cli mcp setup [--dry-run] [--client opencode|claude-desktop|claude-code|cursor] [--live]\n (adds a `solidcraft` server, with this program's path, to each installed AI client; --live adds `solidcraft-live` for the running app; alias: mcp install)\n";
|
|
/// `crashes`'s lines in the usage.
|
|
const USAGE_CRASHES: &str = " solidcraft-cli crashes [list [--json] | show <id> | replay <id> | dir | clear [<id>]]\n";
|
|
/// `licences`'s lines in the usage.
|
|
const USAGE_LICENCES: &str = " solidcraft-cli licences\n";
|
|
/// `gpu`'s lines in the usage.
|
|
const USAGE_GPU: &str = " solidcraft-cli gpu [--policy auto|hardware|software|cpu]\n (the GPU adapters a headless render can open, best first, the one the policy picks and the tier it\n lands on: gpu, gpu-software, or the CPU rasterizer (auto with no adapter, or cpu); the policy defaults\n to SOLIDCRAFT_GPU, else auto; exits with an error when hardware or software finds no such adapter)\n";
|
|
/// `icon`'s lines in the usage.
|
|
const USAGE_ICON: &str = " solidcraft-cli icon --out icon.png [--size 256] | --out icon.ico\n";
|
|
/// `fuzz-one`'s lines in the usage: a seed and the flags of one fuzz run.
|
|
const USAGE_FUZZ_ONE: &str = " solidcraft-cli fuzz-one <seed> [--steps N] [--minimise]\n";
|
|
/// `bench-edit`'s lines in the usage: the parameter a script changes.
|
|
const USAGE_BENCH_EDIT: &str = " solidcraft-cli bench-edit <script.json|recipe.json> <param> <expr>\n";
|
|
/// `save-stress`'s lines in the usage: the file saved over and over.
|
|
const USAGE_SAVE_STRESS: &str = " solidcraft-cli save-stress <path> <rounds>\n";
|
|
/// The flags every command takes, at the end of the top-level usage.
|
|
const USAGE_DEBUG: &str = " --debug, with any command: what SolidCraft logs (why a body has no display plan, why a save left its\n model cache out), on stderr; RUST_LOG=error|warn|info|debug|trace sets one level for every crate\n --max-file-size SIZE, with any command: read STEP and import files and design files up to SIZE for this run\n (for example 2GB or 1500MB; at most 16GB; the defaults are 512 MB and 256 MB, and a smaller SIZE keeps them)\n";
|
|
|
|
/// The commands the CLI takes, in the order the top-level usage lists them.
|
|
const COMMANDS: &[Command] = &[
|
|
Command { name: "run", usage: USAGE_RUN, listed: true },
|
|
Command { name: "eval", usage: USAGE_EVAL, listed: true },
|
|
Command { name: "inspect", usage: USAGE_EVAL, listed: false },
|
|
Command { name: "script", usage: USAGE_SCRIPT, listed: true },
|
|
Command { name: "bench-open", usage: USAGE_BENCH_OPEN, listed: true },
|
|
Command { name: "bench-agent", usage: USAGE_BENCH_AGENT, listed: true },
|
|
Command { name: "bench-assistant", usage: USAGE_BENCH_ASSISTANT, listed: true },
|
|
Command { name: "snapshot", usage: USAGE_SNAPSHOT, listed: true },
|
|
Command { name: "render", usage: USAGE_RENDER, listed: true },
|
|
Command { name: "exec", usage: USAGE_EXEC, listed: true },
|
|
Command { name: "commands", usage: USAGE_COMMANDS, listed: true },
|
|
Command { name: "recipe", usage: USAGE_RECIPE, listed: true },
|
|
Command { name: "oracle", usage: USAGE_ORACLE, listed: true },
|
|
Command { name: "kernel-cases", usage: USAGE_KERNEL_CASES, listed: true },
|
|
Command { name: "fuzz", usage: USAGE_FUZZ, listed: true },
|
|
Command { name: "fuzz-one", usage: USAGE_FUZZ_ONE, listed: false },
|
|
Command { name: "mcp", usage: USAGE_MCP, listed: true },
|
|
Command { name: "crashes", usage: USAGE_CRASHES, listed: true },
|
|
Command { name: "licences", usage: USAGE_LICENCES, listed: true },
|
|
Command { name: "licenses", usage: USAGE_LICENCES, listed: false },
|
|
Command { name: "gpu", usage: USAGE_GPU, listed: true },
|
|
Command { name: "icon", usage: USAGE_ICON, listed: true },
|
|
Command { name: "bench-edit", usage: USAGE_BENCH_EDIT, listed: false },
|
|
Command { name: "save-stress", usage: USAGE_SAVE_STRESS, listed: false },
|
|
];
|
|
|
|
fn main() -> ExitCode {
|
|
let mut args: Vec<String> = std::env::args().skip(1).collect();
|
|
logger::init(&mut args);
|
|
// `--profile` / `--profile-out` (run, eval, bench-open) or SOLIDCRAFT_PROFILE (any command):
|
|
// record from here, and print the table when the command ends.
|
|
let profiling = match args.first().map(String::as_str) {
|
|
Some("run" | "eval" | "inspect" | "bench-open") => profiling::start(&args[1..]),
|
|
_ => profiling::start(&[]),
|
|
};
|
|
let profiling = match profiling {
|
|
Ok(p) => p,
|
|
Err(e) => {
|
|
eprintln!("error: {e}");
|
|
return ExitCode::FAILURE;
|
|
}
|
|
};
|
|
if let Err(e) = max_file_size(&mut args) {
|
|
eprintln!("error: {e}");
|
|
return ExitCode::FAILURE;
|
|
}
|
|
let r = match args.first().map(String::as_str) {
|
|
// Asked-for help is not an error: the command's usage on stdout, exit 0. It is read
|
|
// before the command runs, so `--help` never starts a run (a fuzz run, a server).
|
|
Some(cmd) if wants_help(&args[1..]) && is_command(cmd) => {
|
|
use std::io::Write as _;
|
|
let _ = std::io::stdout().lock().write_all(command_usage(cmd).as_bytes());
|
|
Ok(())
|
|
}
|
|
Some("run") => cmd_run(&args[1..]),
|
|
Some("eval" | "inspect") => cmd_eval(&args[1..]),
|
|
Some("script") => cmd_script(&args[1..]),
|
|
Some("snapshot") => cmd_snapshot(&args[1..]),
|
|
Some("render") => render::run(&args[1..]),
|
|
Some("exec") => cmd_exec(&args[1..]),
|
|
Some("gpu") => cmd_gpu(&args[1..]),
|
|
Some("commands") => {
|
|
use std::io::Write as _;
|
|
let mut s = Session::default();
|
|
s.execute("engine.commands", &json!({})).map_err(|e| e.to_string()).and_then(|v| {
|
|
// A pipeline consumer may stop early (e.g. `commands | head`).
|
|
// Unlike println!, writing explicitly lets us handle that without a panic.
|
|
match writeln!(std::io::stdout().lock(), "{}", pretty(&v)) {
|
|
Ok(()) => Ok(()),
|
|
Err(e) if e.kind() == std::io::ErrorKind::BrokenPipe => Ok(()),
|
|
Err(e) => Err(format!("stdout: {e}")),
|
|
}
|
|
})
|
|
}
|
|
Some("recipe") => args.get(1).ok_or_else(usage).and_then(|p| {
|
|
let v = read_json(p)?;
|
|
recipe::to_script(&v).map(|s| println!("{}", pretty(&s)))
|
|
}),
|
|
Some("oracle") => oracle::run(&args[1..]),
|
|
Some("kernel-cases") => kernel_cases::run(&args[1..]),
|
|
Some("fuzz") => fuzz::run(&args[1..]),
|
|
Some("fuzz-one") => fuzz::one(&args[1..]),
|
|
Some("mcp") => {
|
|
let result = cmd_mcp(&args[1..]);
|
|
solidcraft_mcp::cleanup_scratch_dir();
|
|
result
|
|
}
|
|
Some("crashes") => crashes::run(&args[1..]),
|
|
Some("icon") => cmd_icon(&args[1..]),
|
|
Some("licences" | "licenses") => {
|
|
// Written, not print!ed: a closed pipe (`| head`) is not a crash.
|
|
use std::io::Write as _;
|
|
let _ = std::io::stdout().lock().write_all(solidcraft_engine::licences::all().as_bytes());
|
|
Ok(())
|
|
}
|
|
// Hidden, for the kill-mid-save test: save a large design over and over.
|
|
Some("save-stress") => cmd_save_stress(&args[1..]),
|
|
// Hidden: time recomputes after parameter edits (docs/perf.md).
|
|
Some("bench-edit") => cmd_bench_edit(&args[1..]),
|
|
Some("bench-open") => cmd_bench_open(&args[1..]),
|
|
// A ~1,300-body design built command by command, as an agent builds one over MCP.
|
|
Some("bench-agent") => bench_agent::run(&args[1..]),
|
|
// The standard Assistant model test (#4851), run against a desktop app over its control channel.
|
|
Some("bench-assistant") => bench_assistant::run(&args[1..]),
|
|
Some("--version" | "-V") => {
|
|
println!("solidcraft-cli {}", env!("CARGO_PKG_VERSION"));
|
|
Ok(())
|
|
}
|
|
// Asked-for help is not an error: usage on stdout, exit 0.
|
|
Some("--help" | "-h" | "help") => {
|
|
use std::io::Write as _;
|
|
let _ = std::io::stdout().lock().write_all(usage().as_bytes());
|
|
Ok(())
|
|
}
|
|
_ => Err(usage()),
|
|
};
|
|
// The table also when the command failed: where it spent its time before failing.
|
|
let r = match (r, profiling.map(profiling::Profiling::finish)) {
|
|
(Ok(()), Some(Err(e))) => Err(e),
|
|
(r, _) => r,
|
|
};
|
|
match r {
|
|
Ok(()) => ExitCode::SUCCESS,
|
|
Err(e) => {
|
|
eprintln!("error: {e}");
|
|
ExitCode::FAILURE
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Take `--max-file-size SIZE` (or `--max-file-size=SIZE`), which any command takes, out of the
|
|
/// arguments and raise the file size limits for this run (#4086). A bad size is an error.
|
|
fn max_file_size(args: &mut Vec<String>) -> Result<(), String> {
|
|
let mut size = None;
|
|
let mut i = 0;
|
|
while let Some(arg) = args.get(i) {
|
|
if arg == "--max-file-size" {
|
|
let value = args.get(i + 1).cloned().ok_or("--max-file-size needs a size, for example --max-file-size 2GB")?;
|
|
args.drain(i..i + 2);
|
|
size = Some(value);
|
|
} else if let Some(value) = arg.strip_prefix("--max-file-size=") {
|
|
size = Some(value.to_string());
|
|
args.remove(i);
|
|
} else {
|
|
i += 1;
|
|
}
|
|
}
|
|
let Some(size) = size else { return Ok(()) };
|
|
let bytes = solidcraft_engine::io::limits::parse_flag(&size).map_err(|e| format!("--max-file-size: {e}"))?;
|
|
solidcraft_engine::io::limits::set_override(Some(bytes))
|
|
}
|
|
|
|
fn pretty(v: &Value) -> String {
|
|
serde_json::to_string_pretty(v).unwrap_or_default()
|
|
}
|
|
|
|
/// The whole usage: every command's lines under one `usage:` line. The lines come from the
|
|
/// same place a command's own `--help` prints, so the two cannot drift apart.
|
|
fn usage() -> String {
|
|
let mut s = String::from("usage:\n");
|
|
for c in COMMANDS.iter().filter(|c| c.listed) {
|
|
s.push_str(c.usage);
|
|
}
|
|
s.push_str(USAGE_DEBUG);
|
|
s
|
|
}
|
|
|
|
/// A command's own usage: its lines under a `usage:` line.
|
|
fn command_usage(cmd: &str) -> String {
|
|
match COMMANDS.iter().find(|c| c.name == cmd) {
|
|
Some(c) => format!("usage:\n{}", c.usage),
|
|
None => usage(),
|
|
}
|
|
}
|
|
|
|
/// Whether the name is a command the CLI takes.
|
|
fn is_command(cmd: &str) -> bool {
|
|
COMMANDS.iter().any(|c| c.name == cmd)
|
|
}
|
|
|
|
/// Whether the arguments ask for help.
|
|
fn wants_help(args: &[String]) -> bool {
|
|
args.iter().any(|a| a == "--help" || a == "-h")
|
|
}
|
|
|
|
pub fn read_json(path: &str) -> Result<Value, String> {
|
|
// Through the engine's file access, which refuses anything that is not a regular file and
|
|
// reads no more than the cap: a character device or a FIFO would otherwise never end.
|
|
let s = solidcraft_engine::io::vfs::read_to_string(path, solidcraft_engine::io::limits::max_design_bytes())
|
|
.map_err(|e| format!("{path}: {}", solidcraft_engine::io::limits::explain(solidcraft_engine::io::limits::Kind::Design, e)))?;
|
|
serde_json::from_str(&s).map_err(|e| format!("{path}: {e}"))
|
|
}
|
|
|
|
/// A session from a design file, a STEP/3MF/STL file, a point cloud, a command script, or an oracle recipe.
|
|
pub fn load(path: &str) -> Result<Session, String> {
|
|
load_checked(path, solidcraft_engine::schema::ParamCheck::Off)
|
|
}
|
|
|
|
/// `load`, with scripts and recipes run at the parameter-check level `check`, which the
|
|
/// session keeps.
|
|
fn load_checked(path: &str, check: solidcraft_engine::schema::ParamCheck) -> Result<Session, String> {
|
|
load_with(path, check, solidcraft_engine::kernel::Validation::default())
|
|
}
|
|
|
|
/// `load_checked`, the features computed under `validation` (`diagnostics.validation`), which
|
|
/// the session keeps.
|
|
fn load_with(path: &str, check: solidcraft_engine::schema::ParamCheck, validation: solidcraft_engine::kernel::Validation) -> Result<Session, String> {
|
|
let mut s = Session::default();
|
|
s.param_check = check;
|
|
s.set_validation(validation);
|
|
if solidcraft_engine::io::is_step_path(path) || solidcraft_engine::io::is_mesh_path(path) || solidcraft_engine::io::is_point_cloud_path(path) {
|
|
s.execute("doc.open", &json!({"path": path})).map_err(|e| e.to_string())?;
|
|
return Ok(s);
|
|
}
|
|
let bytes = solidcraft_engine::io::limits::read(path, solidcraft_engine::io::limits::Kind::Design).map_err(|e| format!("{path}: {e}"))?;
|
|
if solidcraft_engine::io::is_design_container(&bytes) {
|
|
let doc = solidcraft_engine::io::read_design(&bytes).map_err(|e| format!("{path}: {e}"))?;
|
|
let mut session = Session::opened_at_validating(doc, None, Some(path), validation);
|
|
session.param_check = check;
|
|
return Ok(session);
|
|
}
|
|
let v: Value = serde_json::from_slice(&bytes).map_err(|e| format!("{path}: {e}"))?;
|
|
if v.get("format").and_then(Value::as_str).is_some_and(|f| solidcraft_engine::doc::format::version_of(f).is_some()) {
|
|
s.execute("doc.open", &json!({"path": path})).map_err(|e| e.to_string())?;
|
|
} else {
|
|
let script = if v.get("features").is_some() && v.get("commands").is_none() { recipe::to_script(&v)? } else { v };
|
|
run_script_warning(&mut s, path, &script)?;
|
|
}
|
|
Ok(s)
|
|
}
|
|
|
|
/// Run `script`, read from `path`, on `s`. At the warn level each step's `param_warnings` go to
|
|
/// stderr as the step completes, even when a later step fails (stdout stays the caller's).
|
|
fn run_script_warning(s: &mut Session, path: &str, script: &Value) -> Result<Vec<Value>, String> {
|
|
s.run_script_each(script, &mut |step, r| print_param_warnings(path, step, r)).map_err(|e| e.to_string())
|
|
}
|
|
|
|
/// Step `step`'s `param_warnings` on stderr, one per line, named after the script at `path`.
|
|
fn print_param_warnings(path: &str, step: usize, r: &Value) {
|
|
for w in r.get("param_warnings").and_then(Value::as_array).into_iter().flatten() {
|
|
eprintln!("{path}: step {}: {}", step + 1, w.as_str().unwrap_or_default());
|
|
}
|
|
}
|
|
|
|
/// `--param-check off|warn|strict`: how calls that break a command's parameter contract are
|
|
/// treated (docs/mcp.md); off when the option isn't given.
|
|
fn parse_param_check(cmd: &str, args: &[String]) -> Result<solidcraft_engine::schema::ParamCheck, String> {
|
|
match flag(args, "--param-check") {
|
|
None if args.iter().any(|a| a == "--param-check") => Err(format!("{cmd}: --param-check wants off, warn or strict")),
|
|
None => Ok(solidcraft_engine::schema::ParamCheck::Off),
|
|
Some(v) => {
|
|
solidcraft_engine::schema::ParamCheck::parse(v).ok_or_else(|| format!("{cmd}: --param-check wants off, warn or strict, not `{v}`"))
|
|
}
|
|
}
|
|
}
|
|
|
|
fn flag<'a>(args: &'a [String], name: &str) -> Option<&'a str> {
|
|
args.iter().position(|a| a == name).and_then(|i| args.get(i + 1)).map(String::as_str)
|
|
}
|
|
|
|
fn flags<'a>(args: &'a [String], name: &str) -> Vec<&'a str> {
|
|
args.windows(2).filter(|w| w[0] == name).map(|w| w[1].as_str()).collect()
|
|
}
|
|
|
|
/// The first argument that is not an option or an option's value.
|
|
fn positional(args: &[String]) -> Option<&String> {
|
|
let mut i = 0;
|
|
while let Some(a) = args.get(i) {
|
|
if a.starts_with("--") {
|
|
i += if matches!(a.as_str(), "--quiet" | "--results" | "--timings" | "--profile" | "--allow-errors" | "--no-grid" | "--no-axes") {
|
|
1
|
|
} else {
|
|
2
|
|
};
|
|
continue;
|
|
}
|
|
return Some(a);
|
|
}
|
|
None
|
|
}
|
|
|
|
/// Is `path` a command script (or a recipe), not a design: JSON that is no saved design.
|
|
fn is_script(path: &str) -> bool {
|
|
let Ok(bytes) = solidcraft_engine::io::vfs::read(path, solidcraft_engine::io::MAX_DESIGN_BYTES) else { return false };
|
|
if solidcraft_engine::io::is_design_container(&bytes) {
|
|
return false;
|
|
}
|
|
serde_json::from_slice::<Value>(&bytes)
|
|
.is_ok_and(|v| !v.get("format").and_then(Value::as_str).is_some_and(|f| solidcraft_engine::doc::format::version_of(f).is_some()))
|
|
}
|
|
|
|
/// `--json-out FILE`: where the JSON a command prints goes instead of stdout.
|
|
fn json_out(args: &[String]) -> Result<Option<&str>, String> {
|
|
if !args.iter().any(|a| a == "--json-out") {
|
|
return Ok(None);
|
|
}
|
|
match flag(args, "--json-out") {
|
|
Some(file) if !file.starts_with("--") => Ok(Some(file)),
|
|
_ => Err("--json-out needs a FILE".to_string()),
|
|
}
|
|
}
|
|
|
|
/// `v` as indented JSON with a final newline: on stdout, or in `file`. The file is plain UTF-8
|
|
/// with no byte-order mark, whatever the platform's shell does to redirected output (Windows
|
|
/// PowerShell's `>` writes UTF-16, or UTF-8 with a BOM), so strict JSON readers take it.
|
|
fn print_json(v: &Value, file: Option<&str>) -> Result<(), String> {
|
|
match file {
|
|
Some(file) => {
|
|
let mut text = pretty(v);
|
|
text.push('\n');
|
|
std::fs::write(file, text).map_err(|e| format!("{file}: {e}"))
|
|
}
|
|
None => {
|
|
println!("{}", pretty(v));
|
|
Ok(())
|
|
}
|
|
}
|
|
}
|
|
|
|
fn cmd_run(args: &[String]) -> Result<(), String> {
|
|
install_renderer();
|
|
let json_out = json_out(args)?;
|
|
// Before the option check, so a bare `--param-check` gets the words `mcp` uses.
|
|
let check = parse_param_check("run", args)?;
|
|
known_args(
|
|
"run",
|
|
args,
|
|
&["--in", "--out", "--save", "--json-out", "--param-check", "--profile-out", "--validation"],
|
|
&["--quiet", "--results", "--timings", "--profile", "--allow-errors"],
|
|
true,
|
|
)?;
|
|
let validation = validation_flag("run", args)?;
|
|
let base = flag(args, "--in");
|
|
let path = positional(args);
|
|
if path.is_none() && base.is_none() {
|
|
return Err(usage());
|
|
}
|
|
let want_results = args.iter().any(|a| a == "--results");
|
|
// `--profile` records the profiler's spans (the table goes to stderr, `profiling.rs`); for a
|
|
// script it also times each command and splits out its kernel time, implying `--timings`.
|
|
let script = path.is_some_and(|p| is_script(p));
|
|
let profile = script && args.iter().any(|a| a == "--profile" || a == "--profile-out");
|
|
let timings = profile || args.iter().any(|a| a == "--timings");
|
|
let (mut s, results) = if want_results || timings {
|
|
// Collect every command's result or time (scripts only), then process requested files too.
|
|
let mut s = match base {
|
|
Some(b) => load_with(b, check, validation)?,
|
|
None => {
|
|
let mut s = Session::default();
|
|
s.set_validation(validation);
|
|
s
|
|
}
|
|
};
|
|
s.param_check = check;
|
|
let needs = if want_results { "--results needs a script" } else { "--timings needs a script" };
|
|
let script = path.ok_or(needs)?;
|
|
let v = read_json(script)?;
|
|
let out = if timings {
|
|
let (r, mut t) = s.run_script_timed(&v, profile, &mut |step, r| print_param_warnings(script, step, r)).map_err(|e| e.to_string())?;
|
|
if want_results && let Some(o) = t.as_object_mut() {
|
|
o.insert("results".into(), Value::Array(r));
|
|
}
|
|
t
|
|
} else {
|
|
Value::Array(run_script_warning(&mut s, script, &v)?)
|
|
};
|
|
(s, Some(out))
|
|
} else {
|
|
(open_validating(base, path, check, validation)?, None)
|
|
};
|
|
// A feature that fails leaves the bodies as they were before it (a parameter change can
|
|
// break a feature without failing the command that made it): writing them would hand out
|
|
// the wrong part with success, so fail the run unless asked to write it anyway.
|
|
if !args.iter().any(|a| a == "--allow-errors") {
|
|
timeline_ok(&s)?;
|
|
}
|
|
for out in flags(args, "--out") {
|
|
s.execute("file.export", &json!({"path": out})).map_err(|e| e.to_string())?;
|
|
}
|
|
if let Some(p) = flag(args, "--save") {
|
|
s.execute("file.save_as", &json!({"path": p})).map_err(|e| e.to_string())?;
|
|
}
|
|
if let Some(results) = results {
|
|
print_json(&results, json_out)?;
|
|
} else if json_out.is_some() || !args.iter().any(|a| a == "--quiet") {
|
|
// `--quiet` silences stdout; a file that was asked for is still written.
|
|
let m = s.execute("inspect.measure", &json!({})).map_err(|e| e.to_string())?;
|
|
print_json(&m, json_out)?;
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
/// The session `run`, `eval` and `snapshot` start from: `--in` (a design or STEP file) with the
|
|
/// positional script run on top of it, or either one alone, with scripts run at `check`.
|
|
fn open(base: Option<&str>, path: Option<&String>, check: solidcraft_engine::schema::ParamCheck) -> Result<Session, String> {
|
|
open_validating(base, path, check, solidcraft_engine::kernel::Validation::default())
|
|
}
|
|
|
|
/// [`open`], the features computed under `validation`.
|
|
fn open_validating(
|
|
base: Option<&str>,
|
|
path: Option<&String>,
|
|
check: solidcraft_engine::schema::ParamCheck,
|
|
validation: solidcraft_engine::kernel::Validation,
|
|
) -> Result<Session, String> {
|
|
let load = |p: &str| load_with(p, check, validation);
|
|
match (base, path) {
|
|
(Some(b), Some(p)) => {
|
|
let mut s = load(b)?;
|
|
run_script_warning(&mut s, p, &read_json(p)?)?;
|
|
Ok(s)
|
|
}
|
|
(Some(b), None) => load(b),
|
|
(None, Some(p)) => load(p),
|
|
(None, None) => Err(usage()),
|
|
}
|
|
}
|
|
|
|
/// `--validation MODE` (`diagnostics.validation`): the default, each_feature, when not given.
|
|
fn validation_flag(cmd: &str, args: &[String]) -> Result<solidcraft_engine::kernel::Validation, String> {
|
|
match flag(args, "--validation") {
|
|
Some(m) => solidcraft_engine::kernel::Validation::parse(m)
|
|
.ok_or_else(|| format!("{cmd}: --validation must be each_step, each_feature or off, not `{m}`")),
|
|
None => Ok(solidcraft_engine::kernel::Validation::default()),
|
|
}
|
|
}
|
|
|
|
/// Refuses an option `cmd` doesn't take, and one missing its value: a typo, or another
|
|
/// command's option, would otherwise be ignored without a word. `positionals` says whether the
|
|
/// command takes a word of its own (a file, a seed): `fuzz` takes none, and would start a run.
|
|
fn known_args(cmd: &str, args: &[String], valued: &[&str], switches: &[&str], positionals: bool) -> Result<(), String> {
|
|
let mut i = 0;
|
|
while let Some(a) = args.get(i) {
|
|
if valued.contains(&a.as_str()) {
|
|
match args.get(i + 1) {
|
|
Some(v) if !v.starts_with("--") => i += 2,
|
|
_ => return Err(format!("{cmd}: {a} needs a value")),
|
|
}
|
|
} else if switches.contains(&a.as_str()) {
|
|
i += 1;
|
|
} else if a.starts_with("--") || !positionals {
|
|
return Err(format!("{cmd} doesn't take {a} (it takes {})", [valued, switches].concat().join(", ")));
|
|
} else {
|
|
i += 1;
|
|
}
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
/// Every failing timeline feature, one per line, as an error; Ok when none fails.
|
|
fn timeline_ok(s: &Session) -> Result<(), String> {
|
|
let failed: Vec<String> = s.model.results.iter().filter_map(|r| r.error.as_ref().map(|e| format!(" {}: {e}", r.name))).collect();
|
|
if failed.is_empty() {
|
|
return Ok(());
|
|
}
|
|
Err(format!(
|
|
"{} timeline feature(s) failed, so nothing was written (--allow-errors writes the bodies anyway):\n{}",
|
|
failed.len(),
|
|
failed.join("\n")
|
|
))
|
|
}
|
|
|
|
fn cmd_eval(args: &[String]) -> Result<(), String> {
|
|
let json_out = json_out(args)?;
|
|
known_args("eval", args, &["--in", "--json-out", "--profile-out"], &["--profile"], true)?;
|
|
let mut s = open(flag(args, "--in"), positional(args), solidcraft_engine::schema::ParamCheck::Off)?;
|
|
let m = s.execute("inspect.measure", &json!({})).map_err(|e| e.to_string())?;
|
|
let d = s.execute("document.inspect", &json!({})).map_err(|e| e.to_string())?;
|
|
let out = json!({
|
|
"body_count": m["body_count"],
|
|
"bodies": m["bodies"],
|
|
"total": m["total"],
|
|
"timeline": d["timeline"],
|
|
"params": d["params"],
|
|
"sketches": d["sketches"],
|
|
});
|
|
print_json(&out, json_out)
|
|
}
|
|
|
|
/// A design's history as a command script (`timeline.export_script`): printed, or written to
|
|
/// `--out`; what the script leaves out goes to stderr.
|
|
fn cmd_script(args: &[String]) -> Result<(), String> {
|
|
let path = positional(args).ok_or_else(usage)?;
|
|
let s = &mut load(path)?;
|
|
let out = flag(args, "--out");
|
|
let r = s.execute("timeline.export_script", &json!({"path": out})).map_err(|e| e.to_string())?;
|
|
for what in r["omitted"].as_array().into_iter().flatten().filter_map(Value::as_str) {
|
|
eprintln!("note: the script leaves out {what}");
|
|
}
|
|
match out {
|
|
Some(out) => eprintln!("{out}: {} steps", r["steps"]),
|
|
None => println!("{}", pretty(&r["script"])),
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
/// `gpu`: the headless adapter survey and the policy's pick.
|
|
fn cmd_gpu(args: &[String]) -> Result<(), String> {
|
|
use solidcraft_gpu::select::{Policy, survey};
|
|
let policy = match args {
|
|
[] => Policy::from_env()?,
|
|
[flag, v] if flag == "--policy" => Policy::parse(v).ok_or_else(|| format!("--policy must be auto, hardware, software or cpu, not `{v}`"))?,
|
|
_ => return Err("usage: solidcraft-cli gpu [--policy auto|hardware|software|cpu]".into()),
|
|
};
|
|
let s = survey(policy);
|
|
let chosen = s.chosen.and_then(|i| s.adapters.get(i)).cloned();
|
|
// The tier pictures land on: a hardware GPU, a software adapter, or the CPU rasterizer.
|
|
let renderer = s.lands_on.map(|l| l.renderer());
|
|
println!(
|
|
"{}",
|
|
pretty(&json!({
|
|
"policy": policy.name(),
|
|
"backends": s.backends,
|
|
"adapters": s.adapters,
|
|
"chosen": chosen,
|
|
"lands_on": s.lands_on,
|
|
"renderer": renderer,
|
|
}))
|
|
);
|
|
match s.lands_on {
|
|
Some(solidcraft_gpu::select::Landing::Cpu) => {
|
|
eprintln!("warning: {}", solidcraft_engine::capture::CPU_WARNING);
|
|
Ok(())
|
|
}
|
|
Some(_) => Ok(()),
|
|
None => Err(format!("no adapter qualifies under the {} policy", policy.name())),
|
|
}
|
|
}
|
|
|
|
/// Draw this process's pictures (snapshots, MCP screenshots, saved thumbnails) on the GPU with the
|
|
/// viewport's pipelines: the headless device the `SOLIDCRAFT_GPU` policy picks, opened on the first
|
|
/// picture; under `auto` with no qualifying adapter (or `cpu`), the CPU rasterizer, and the
|
|
/// picture says so. Under `hardware` or `software` with no such adapter a picture fails with an
|
|
/// error that names the policy.
|
|
fn install_renderer() {
|
|
solidcraft_engine::capture::install(std::sync::Arc::new(|scene, cam, w, h| {
|
|
let (rgba, renderer) = solidcraft_gpu::capture::headless_rgba(scene, cam, w, h)?;
|
|
Ok(solidcraft_engine::capture::Picture { rgba, renderer })
|
|
}));
|
|
}
|
|
|
|
fn cmd_snapshot(args: &[String]) -> Result<(), String> {
|
|
install_renderer();
|
|
known_args(
|
|
"snapshot",
|
|
args,
|
|
&["--in", "--out", "--width", "--height", "--view", "--camera", "--body", "--tool", "--section", "--quality"],
|
|
&["--no-grid", "--no-axes"],
|
|
true,
|
|
)?;
|
|
if positional(args).is_none() && flag(args, "--in").is_none() {
|
|
return Err(usage());
|
|
}
|
|
let out = flag(args, "--out").ok_or("snapshot needs --out FILE.png")?;
|
|
let size = |name: &str, default: u32| match flag(args, name) {
|
|
None => Ok(default),
|
|
Some(x) => x.parse().ok().filter(|n| (16..=8192).contains(n)).ok_or_else(|| format!("{name} must be 16 to 8192 pixels, not `{x}`")),
|
|
};
|
|
let (w, h) = (size("--width", 1280)?, size("--height", 800)?);
|
|
// The display quality the bodies are meshed at, as the app's Display Quality setting: set
|
|
// before the design opens, so every display plan is made at it.
|
|
if let Some(q) = flag(args, "--quality") {
|
|
use solidcraft_engine::doc::display_quality::{DisplayQuality, set_current};
|
|
let level = DisplayQuality::parse(q).ok_or_else(|| {
|
|
let ids: Vec<&str> = DisplayQuality::ALL.iter().map(|q| q.id()).collect();
|
|
format!("--quality must be one of {}, not `{q}`", ids.join(", "))
|
|
})?;
|
|
set_current(level);
|
|
}
|
|
let mut s = open(flag(args, "--in"), positional(args), solidcraft_engine::schema::ParamCheck::Off)?;
|
|
// How the bodies are drawn and where the model is cut, through the commands the app's
|
|
// Appearance dialog and Section Analysis run (`preview`).
|
|
preview::apply(&mut s, &flags(args, "--body"), &flags(args, "--tool"), flag(args, "--section"))?;
|
|
// The camera choices of the MCP `screenshot`, through the same command (`view.apply`): a
|
|
// standard view, a view saved in the design, or an explicit camera. A script that applies a
|
|
// view itself sets the camera too; without any, the iso view framing the model.
|
|
match (flag(args, "--view"), flag(args, "--camera")) {
|
|
(Some(_), Some(_)) => return Err("snapshot: give --view or --camera, not both".into()),
|
|
(Some(v), None) => {
|
|
let hint = "standard views: iso, front, back, top, bottom, left, right";
|
|
s.execute("view.apply", &json!({"view": v})).map_err(|e| format!("--view {v}: {e} ({hint}; or a view saved with view.save)"))?;
|
|
}
|
|
(None, Some(c)) => {
|
|
let camera: Value = serde_json::from_str(c).map_err(|e| format!("--camera: not JSON: {e}"))?;
|
|
s.execute("view.apply", &json!({"camera": camera})).map_err(|e| format!("--camera: {e}"))?;
|
|
}
|
|
(None, None) => {}
|
|
}
|
|
let cam = match s.camera {
|
|
Some(cam) => cam,
|
|
None => solidcraft_engine::view::home_camera(&s).map_err(|e| e.to_string())?,
|
|
};
|
|
let guides = Guides { grid: !args.iter().any(|a| a == "--no-grid"), axes: !args.iter().any(|a| a == "--no-axes") };
|
|
let scene = solidcraft_engine::view::scene_with_guides(&s, &cam, s.section, guides).map_err(|e| e.to_string())?;
|
|
let png = solidcraft_engine::capture::png(&scene, &cam, w, h)?;
|
|
std::fs::write(out, &png.bytes).map_err(|e| format!("{out}: {e}"))?;
|
|
let mut reply = json!({"path": out, "width": w, "height": h, "bytes": png.bytes.len(), "renderer": png.renderer});
|
|
if let Some(w) = solidcraft_engine::capture::warning(png.renderer) {
|
|
eprintln!("warning: {w}");
|
|
reply["warning"] = json!(w);
|
|
}
|
|
println!("{}", pretty(&reply));
|
|
Ok(())
|
|
}
|
|
|
|
/// The app icon: the SolidCraft logo, drawn in code on a transparent background
|
|
/// (so packages need no committed image). `.ico` holds the Windows sizes as PNGs.
|
|
fn cmd_icon(args: &[String]) -> Result<(), String> {
|
|
let out = flag(args, "--out").ok_or("icon needs --out FILE.png or FILE.ico")?;
|
|
let size: usize = flag(args, "--size").and_then(|x| x.parse().ok()).unwrap_or(256).clamp(8, 2048);
|
|
let bytes = if out.to_ascii_lowercase().ends_with(".ico") {
|
|
let pngs: Vec<(usize, Vec<u8>)> =
|
|
[16, 20, 24, 32, 40, 48, 64, 128, 256].into_iter().map(|s| icon_png(s).map(|p| (s, p))).collect::<Result<_, _>>()?;
|
|
ico(&pngs)?
|
|
} else {
|
|
icon_png(size)?
|
|
};
|
|
std::fs::write(out, &bytes).map_err(|e| format!("{out}: {e}"))?;
|
|
println!("{}", pretty(&json!({"path": out, "bytes": bytes.len()})));
|
|
Ok(())
|
|
}
|
|
|
|
fn icon_png(size: usize) -> Result<Vec<u8>, String> {
|
|
solidcraft_engine::render::png(size, size, app_icon::rgba(size)?).ok_or_else(|| "icon: PNG encoding failed".to_string())
|
|
}
|
|
|
|
/// A Windows icon file holding PNG images (Vista and later read these).
|
|
fn ico(images: &[(usize, Vec<u8>)]) -> Result<Vec<u8>, String> {
|
|
let n = u16::try_from(images.len()).map_err(|_| "too many icon sizes")?;
|
|
let mut out = Vec::new();
|
|
out.extend_from_slice(&[0, 0, 1, 0]);
|
|
out.extend_from_slice(&n.to_le_bytes());
|
|
let mut offset = 6 + 16 * images.len();
|
|
for (size, data) in images {
|
|
let dim = if *size >= 256 { 0 } else { *size as u8 };
|
|
out.extend_from_slice(&[dim, dim, 0, 0, 1, 0, 32, 0]);
|
|
out.extend_from_slice(&u32::try_from(data.len()).map_err(|_| "icon too large")?.to_le_bytes());
|
|
out.extend_from_slice(&u32::try_from(offset).map_err(|_| "icon too large")?.to_le_bytes());
|
|
offset += data.len();
|
|
}
|
|
for (_, data) in images {
|
|
out.extend_from_slice(data);
|
|
}
|
|
Ok(out)
|
|
}
|
|
|
|
fn cmd_exec(args: &[String]) -> Result<(), String> {
|
|
install_renderer();
|
|
let id = args.first().ok_or_else(usage)?;
|
|
let p: Value = match args.get(1) {
|
|
Some(t) => serde_json::from_str(t).map_err(|e| format!("params: {e}"))?,
|
|
None => json!({}),
|
|
};
|
|
let mut s = Session::default();
|
|
let v = s.execute(id, &p).map_err(|e| e.to_string())?;
|
|
println!("{}", pretty(&v));
|
|
Ok(())
|
|
}
|
|
|
|
/// `mcp setup`: add the server to each installed AI client, with this program's own path.
|
|
fn cmd_mcp_setup(args: &[String]) -> Result<(), String> {
|
|
use solidcraft_engine::agent_setup as setup;
|
|
let (lines, ok) = setup::setup(args, &setup::Env::from_process(), &setup::current_exe()?)?;
|
|
for l in lines {
|
|
println!("{l}");
|
|
}
|
|
if ok { Ok(()) } else { Err("mcp setup: some clients could not be configured".into()) }
|
|
}
|
|
|
|
/// MCP server on stdio: headless (optionally starting from a design or script) or bridged to
|
|
/// a running app's control port. stdout carries only protocol messages. Files the agent's tool
|
|
/// calls reach are confined to `solidcraft_mcp::agent_scope` unless `--allow-any-path` is given.
|
|
fn cmd_mcp(args: &[String]) -> Result<(), String> {
|
|
if matches!(args.first().map(String::as_str), Some("setup" | "install")) {
|
|
return cmd_mcp_setup(&args[1..]);
|
|
}
|
|
let render_gpu = args.iter().any(|arg| arg == "--render-gpu");
|
|
if render_gpu && flag(args, "--connect").is_some() {
|
|
return Err("mcp: --render-gpu installs a headless image host; a connected application owns its own device".into());
|
|
}
|
|
install_renderer();
|
|
let scope = (!args.iter().any(|a| a == "--allow-any-path"))
|
|
.then(|| solidcraft_mcp::agent_scope(flags(args, "--allow-path").into_iter().map(std::path::PathBuf::from)));
|
|
if let Some(s) = &scope {
|
|
let roots: Vec<String> = s.roots().iter().map(|r| r.display().to_string()).collect();
|
|
eprintln!(
|
|
"solidcraft mcp: files limited to {} and the folders of designs opened or saved here (--allow-path DIR adds one, --allow-any-path lifts the limit)",
|
|
roots.join(", ")
|
|
);
|
|
let design_dir = flag(args, "--in")
|
|
.and_then(|p| std::path::Path::new(p).parent())
|
|
.map(|d| if d.as_os_str().is_empty() { std::path::Path::new(".") } else { d });
|
|
if let Some(why) = design_dir.and_then(solidcraft_engine::io::vfs::design_folder_refusal) {
|
|
eprintln!("solidcraft mcp: the design's folder is left out because {why}; add it with --allow-path if you mean it");
|
|
}
|
|
}
|
|
// How calls that break a command's parameter contract are treated, headless or bridged.
|
|
let param_check = parse_param_check("mcp", args)?;
|
|
let backend: Box<dyn solidcraft_mcp::Backend> = match (flag(args, "--connect"), flag(args, "--in")) {
|
|
(Some(_), Some(_)) => return Err("mcp: use either --connect or --in, not both".into()),
|
|
(Some(addr), None) => {
|
|
let Some(port) = addr.rsplit_once(':').and_then(|(_, p)| p.parse::<u16>().ok()).filter(|p| *p != 0) else {
|
|
return Err(format!("mcp: --connect wants HOST:PORT, such as 127.0.0.1:7878, not `{addr}`"));
|
|
};
|
|
// Serve without the app too: the tools connect once it runs, and say it isn't until then.
|
|
let mut remote = solidcraft_mcp::Remote::new(addr, flag(args, "--token")).with_param_check(param_check);
|
|
if let Err(e) = remote.try_connect() {
|
|
eprintln!(
|
|
"solidcraft mcp: no SolidCraft app at {addr} yet ({e}); start it with `solidcraft --control {port}` \
|
|
(or SOLIDCRAFT_CONTROL_PORT={port}), tool calls connect once it runs"
|
|
);
|
|
}
|
|
Box::new(remote)
|
|
}
|
|
(None, Some(path)) => {
|
|
let mut headless = solidcraft_mcp::Headless::new(load_checked(path, param_check)?);
|
|
if render_gpu {
|
|
headless.session.register_render_job_host(solidcraft_gpu::path::host().map_err(|e| e.to_string())?).map_err(|e| e.to_string())?;
|
|
}
|
|
Box::new(headless)
|
|
}
|
|
(None, None) => {
|
|
let auto = !args.iter().any(|a| a == "--headless");
|
|
if auto && let Some(port) = discover_app() {
|
|
eprintln!("solidcraft mcp: bridged to the running app at 127.0.0.1:{port} (--headless starts a session of its own)");
|
|
let remote = solidcraft_mcp::Remote::new(&format!("127.0.0.1:{port}"), flag(args, "--token")).with_param_check(param_check);
|
|
return serve_mcp(Box::new(remote), scope);
|
|
}
|
|
let mut headless = solidcraft_mcp::Headless::default();
|
|
headless.session.param_check = param_check;
|
|
if render_gpu {
|
|
headless.session.register_render_job_host(solidcraft_gpu::path::host().map_err(|e| e.to_string())?).map_err(|e| e.to_string())?;
|
|
}
|
|
if auto {
|
|
// The app may start after the agent: look for it again until there is work here.
|
|
Box::new(solidcraft_mcp::Auto::new(headless, Box::new(discover_app), flag(args, "--token")))
|
|
} else {
|
|
Box::new(headless)
|
|
}
|
|
}
|
|
};
|
|
serve_mcp(backend, scope)
|
|
}
|
|
|
|
fn serve_mcp(backend: Box<dyn solidcraft_mcp::Backend>, scope: Option<solidcraft_engine::io::vfs::PathScope>) -> Result<(), String> {
|
|
let stdin = std::io::stdin();
|
|
let stdout = std::io::stdout();
|
|
solidcraft_mcp::Server::new(backend).with_path_scope(scope).serve(stdin.lock(), stdout.lock()).map_err(|e| e.to_string())
|
|
}
|
|
|
|
/// The port of the running desktop app: the one its discovery file names, if something listens
|
|
/// there (a file left by an app that crashed names a closed port).
|
|
fn discover_app() -> Option<u16> {
|
|
let port = solidcraft_engine::control_auth::read_current_port()?;
|
|
let addr = std::net::SocketAddr::from(([127, 0, 0, 1], port));
|
|
std::net::TcpStream::connect_timeout(&addr, std::time::Duration::from_millis(500)).ok().map(|_| port)
|
|
}
|
|
|
|
/// `save-stress <path> <rounds>`: save a design of a few hundred kilobytes `rounds` times, its
|
|
/// parameter `save_round` set to the round number each time.
|
|
fn cmd_save_stress(args: &[String]) -> Result<(), String> {
|
|
let (Some(path), Some(rounds)) = (args.first(), args.get(1).and_then(|n| n.parse::<u64>().ok())) else {
|
|
return Err("usage: solidcraft-cli save-stress <path> <rounds>".into());
|
|
};
|
|
let mut s = Session::default();
|
|
let filler = (0..3000).map(|i| solidcraft_engine::doc::Param {
|
|
name: format!("p{i}"),
|
|
expr: format!("{i} mm + 0.5 mm"),
|
|
unit: "mm".into(),
|
|
comment: "filler to make the file large".into(),
|
|
model: false,
|
|
});
|
|
s.doc_mut().params.extend(filler);
|
|
for r in 0..rounds {
|
|
s.doc_mut().set_param("save_round", &r.to_string(), None, None).map_err(|e| e.to_string())?;
|
|
s.execute("file.save", &json!({ "path": path })).map_err(|e| e.to_string())?;
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
/// `bench-edit <script.json|recipe.json> <param> <expr>`: build the design, then time a
|
|
/// parameter edit, setting it back, undo and redo (ms and features recomputed each).
|
|
fn cmd_bench_edit(args: &[String]) -> Result<(), String> {
|
|
let (Some(path), Some(param), Some(expr)) = (args.first(), args.get(1), args.get(2)) else {
|
|
return Err("usage: solidcraft-cli bench-edit <script.json|recipe.json> <param> <expr>".into());
|
|
};
|
|
let v = read_json(path)?;
|
|
let script = if v.get("features").is_some() { recipe::to_script(&v)? } else { v };
|
|
let mut s = Session::default();
|
|
let t = std::time::Instant::now();
|
|
s.run_script(&script).map_err(|e| e.to_string())?;
|
|
let build = t.elapsed().as_secs_f64() * 1000.0;
|
|
let old = s.doc.all_param_exprs().into_iter().find(|(n, _, _)| n == param).map(|(_, e, _)| e).ok_or(format!("no parameter `{param}`"))?;
|
|
let mut out = vec![json!({"step": "build", "ms": build, "features": s.doc.features.len()})];
|
|
let mut time = |s: &mut Session, step: &str, id: &str, p: Value| -> Result<(), String> {
|
|
let t = std::time::Instant::now();
|
|
let r = s.execute(id, &p).map_err(|e| format!("{step}: {e}"))?;
|
|
let n = r.get("recomputed").cloned().unwrap_or_else(|| json!(s.model.last_recomputed));
|
|
out.push(json!({"step": step, "ms": t.elapsed().as_secs_f64() * 1000.0, "recomputed": n}));
|
|
Ok(())
|
|
};
|
|
let expr = expr.replace("{old}", &old);
|
|
time(&mut s, "edit", "parameters.change", json!({"name": param, "expression": expr}))?;
|
|
time(&mut s, "set back", "parameters.change", json!({"name": param, "expression": old}))?;
|
|
time(&mut s, "undo", "edit.undo", json!({}))?;
|
|
time(&mut s, "redo", "edit.redo", json!({}))?;
|
|
println!("{}", pretty(&json!(out)));
|
|
Ok(())
|
|
}
|
|
|
|
/// `bench-open --ops`: each command of `script` (a JSON array of `{command, params}`), then its
|
|
/// undo, each timed as the command and the view it leaves (the placed model, its meshes warmed
|
|
/// as the desktop does after a change).
|
|
fn bench_ops(mut s: Session, script: &str) -> Result<Session, String> {
|
|
let text = std::fs::read_to_string(script).map_err(|e| format!("{script}: {e}"))?;
|
|
let ops: Value = serde_json::from_str(&text).map_err(|e| format!("{script}: {e}"))?;
|
|
let ops = ops.as_array().ok_or("--ops: a JSON array of {command, params}")?;
|
|
let time = |s: &mut Session, id: &str, p: &Value| -> Result<Value, String> {
|
|
let t = std::time::Instant::now();
|
|
let r = s.execute(id, p).map_err(|e| format!("{id}: {e}"))?;
|
|
let ms = t.elapsed().as_secs_f64() * 1000.0;
|
|
let t = std::time::Instant::now();
|
|
s.world_state().map_err(|e| e.to_string())?.warm_meshes(|| true);
|
|
let view_ms = t.elapsed().as_secs_f64() * 1000.0;
|
|
println!("{}", json!({"step": "op", "command": id, "ms": ms, "view_ms": view_ms}));
|
|
Ok(r)
|
|
};
|
|
for op in ops {
|
|
let id = op.get("command").and_then(Value::as_str).ok_or("--ops: each step needs a `command`")?;
|
|
let p = op.get("params").cloned().unwrap_or(Value::Null);
|
|
let steps = s.undo.len();
|
|
time(&mut s, id, &p)?;
|
|
// Commands that are no undo step (showing and hiding) have nothing to undo.
|
|
if op.get("undo").and_then(Value::as_bool) != Some(false) && s.undo.len() > steps {
|
|
time(&mut s, "edit.undo", &json!({}))?;
|
|
}
|
|
}
|
|
Ok(s)
|
|
}
|
|
|
|
/// Separate file reading, JSON decoding/repair, timeline evaluation and display meshing.
|
|
pub(crate) fn cmd_bench_open(args: &[String]) -> Result<(), String> {
|
|
let path = args.first().ok_or("usage: solidcraft-cli bench-open <design.sc | part.step> [--parse-only]")?;
|
|
let t = std::time::Instant::now();
|
|
let step = solidcraft_engine::io::is_step_path(path);
|
|
let kind = if step { solidcraft_engine::io::limits::Kind::Step } else { solidcraft_engine::io::limits::Kind::Design };
|
|
let bytes = solidcraft_engine::io::limits::read(path, kind).map_err(|e| format!("{path}: {e}"))?;
|
|
let read_ms = t.elapsed().as_secs_f64() * 1000.0;
|
|
println!("{}", json!({"step": "read", "ms": read_ms, "bytes": bytes.len()}));
|
|
let t = std::time::Instant::now();
|
|
// The file as read, held until the timeline has evaluated it (as the import command does).
|
|
let mut read = None;
|
|
let (doc, saved) = if step {
|
|
let imported = solidcraft_engine::io::step_import_feature(&bytes, path).map_err(|e| e.to_string())?;
|
|
let mut doc = solidcraft_engine::doc::Document::new(&imported.name);
|
|
doc.add_feature(imported.kind, Some(&imported.name)).map_err(|e| e.to_string())?;
|
|
read = Some(imported.import);
|
|
(doc, None)
|
|
} else {
|
|
// As Open reads it: with the model the file keeps.
|
|
solidcraft_engine::io::read_design_file(path, None::<fn(solidcraft_engine::io::DesignPreview)>).map_err(|e| e.to_string())?
|
|
};
|
|
let parse_ms = t.elapsed().as_secs_f64() * 1000.0;
|
|
println!("{}", json!({"step": "parse", "ms": parse_ms, "features": doc.features.len(), "saved_model": saved.is_some()}));
|
|
if args.iter().any(|a| a == "--parse-only") {
|
|
return Ok(());
|
|
}
|
|
let t = std::time::Instant::now();
|
|
let s = Session::opened_at(doc, saved.as_ref(), (!step).then_some(path.as_str()));
|
|
drop(read);
|
|
// Taken from the file: nothing evaluated (SOLIDCRAFT_NO_MODEL_CACHE evaluates anyway), or
|
|
// only the features whose state a thinned file left out.
|
|
let adopted = saved.is_some() && s.model.last_recomputed == 0;
|
|
println!("{}", json!({"step": "evaluate", "ms": t.elapsed().as_secs_f64() * 1000.0, "adopted": adopted, "recomputed": s.model.last_recomputed}));
|
|
for r in &s.model.results {
|
|
println!("{}", json!({"step": "feature", "id": r.id, "name": r.name, "ms": r.ms, "error": r.error}));
|
|
}
|
|
let t = std::time::Instant::now();
|
|
let st = s.world_state().map_err(|e| e.to_string())?;
|
|
let place_ms = t.elapsed().as_secs_f64() * 1000.0;
|
|
// As the desktop app prepares a design it opened.
|
|
st.warm_meshes(|| true);
|
|
let triangles: usize = st.bodies.iter().map(|b| b.mesh().triangles.len()).sum();
|
|
println!(
|
|
"{}",
|
|
json!({"step": "mesh", "ms": t.elapsed().as_secs_f64() * 1000.0, "place_ms": place_ms, "bodies": st.bodies.len(), "triangles": triangles})
|
|
);
|
|
let flag = |name: &str| args.iter().position(|a| a == name);
|
|
// `--save PATH`: save the opened design without its model cache (to PATH.plain.sc) and
|
|
// as the app does, with it, then read the cache back.
|
|
let s = match flag("--save").and_then(|i| args.get(i + 1)) {
|
|
Some(out) => {
|
|
let mut s = s;
|
|
// Without the cache first, for comparison.
|
|
let plain = format!("{out}.plain.{}", solidcraft_engine::io::DESIGN_EXT);
|
|
let t = std::time::Instant::now();
|
|
s.execute("file.save_as", &json!({"path": plain, "cache": false})).map_err(|e| e.to_string())?;
|
|
let plain_ms = t.elapsed().as_secs_f64() * 1000.0;
|
|
let plain_bytes = std::fs::metadata(&plain).map(|m| m.len()).unwrap_or(0);
|
|
let t = std::time::Instant::now();
|
|
s.execute("file.save_as", &json!({"path": out})).map_err(|e| e.to_string())?;
|
|
let save_ms = t.elapsed().as_secs_f64() * 1000.0;
|
|
let bytes = std::fs::read(out).map_err(|e| format!("{out}: {e}"))?;
|
|
let t = std::time::Instant::now();
|
|
let cached = solidcraft_engine::io::read_design_geometry(&bytes).map(|m| m.bodies.len());
|
|
let read_ms = t.elapsed().as_secs_f64() * 1000.0;
|
|
// Why bodies could not be kept exactly, when the cache was left out.
|
|
let mut refused = std::collections::BTreeMap::<String, usize>::new();
|
|
if cached.is_none() {
|
|
for b in &s.model.state().bodies {
|
|
if let Err(e) = solidcraft_engine::kernel::encode_native_body(&b.body) {
|
|
*refused.entry(e.to_string()).or_default() += 1;
|
|
}
|
|
}
|
|
}
|
|
println!(
|
|
"{}",
|
|
json!({"step": "save", "ms": save_ms, "bytes": bytes.len(), "plain_ms": plain_ms, "plain_bytes": plain_bytes, "cached_bodies": cached, "cache_read_ms": read_ms, "refused": refused})
|
|
);
|
|
s
|
|
}
|
|
None => s,
|
|
};
|
|
// `--display LEVEL`: the display plans the viewport draws at that display quality, made as
|
|
// the GPU viewport makes them; `--edit NAME EXPR` then changes a parameter and times the
|
|
// evaluation and the plans of the bodies it changed.
|
|
let s = match flag("--ops").and_then(|i| args.get(i + 1)) {
|
|
Some(ops) => bench_ops(s, ops)?,
|
|
None => s,
|
|
};
|
|
let Some(level) = flag("--display").and_then(|i| args.get(i + 1)) else { return Ok(()) };
|
|
let q = solidcraft_engine::doc::display_quality::DisplayQuality::parse(level).ok_or("--display: coarse, normal, fine or ultra")?;
|
|
let plans = |st: &solidcraft_engine::doc::ModelState| {
|
|
let t = std::time::Instant::now();
|
|
solidcraft_engine::kernel::for_each_on_threads(&st.bodies, 16, |b| {
|
|
let _ = b.plan_mesh_at(q);
|
|
});
|
|
let triangles: usize = st.bodies.iter().filter_map(|b| b.plan_mesh_at(q)).map(|m| m.triangles.len()).sum();
|
|
(t.elapsed().as_secs_f64() * 1000.0, triangles)
|
|
};
|
|
let (ms, triangles) = plans(&st);
|
|
println!("{}", json!({"step": "display", "quality": q.id(), "ms": ms, "triangles": triangles}));
|
|
if let Some(i) = flag("--edit") {
|
|
let (Some(name), Some(expr)) = (args.get(i + 1), args.get(i + 2)) else { return Err("--edit NAME EXPR".into()) };
|
|
let mut s = s;
|
|
let t = std::time::Instant::now();
|
|
s.execute("parameters.change", &json!({"name": name, "expression": expr})).map_err(|e| e.to_string())?;
|
|
let eval_ms = t.elapsed().as_secs_f64() * 1000.0;
|
|
let st = s.world_state().map_err(|e| e.to_string())?;
|
|
let t = std::time::Instant::now();
|
|
st.warm_meshes(|| true);
|
|
let mesh_ms = t.elapsed().as_secs_f64() * 1000.0;
|
|
let (ms, triangles) = plans(&st);
|
|
println!(
|
|
"{}",
|
|
json!({"step": "edit", "quality": q.id(), "evaluate_ms": eval_ms, "mesh_ms": mesh_ms, "display_ms": ms, "triangles": triangles})
|
|
);
|
|
}
|
|
Ok(())
|
|
}
|