Skip to content

Commit 9b7e822

Browse files
committed
Add documentation about CLI command open-step
1 parent 6047b9f commit 9b7e822

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

modules/cli/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
** xref:help.adoc[]
44
** xref:open-library.adoc[]
55
** xref:open-project.adoc[]
6+
** xref:open-step.adoc[]

modules/cli/pages/open-step.adoc

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
= Command "open-step"
2+
3+
This command opens a STEP file and lets you execute some tasks with it.
4+
5+
.Command
6+
[source,bash]
7+
----
8+
./librepcb-cli open-step --help
9+
----
10+
11+
.Output
12+
----
13+
Usage: ./librepcb-cli [options] open-step [command_options] file
14+
LibrePCB Command Line Interface
15+
16+
Options:
17+
-h, --help Print this message.
18+
-V, --version Displays version information.
19+
-v, --verbose Verbose output.
20+
--minify Minify the STEP model before validating it. Use in
21+
conjunction with '--save-to' to save the output of the
22+
operation.
23+
--tesselate Tesselate the loaded STEP model to check if LibrePCB is
24+
able to render it. Reports failure (exit code = 1) if no
25+
content is detected.
26+
--save-to <file> Write the (modified) STEP file to this output location (may
27+
be equal to the opened file path). Only makes sense in
28+
conjunction with '--minify'.
29+
30+
Arguments:
31+
open-step Open a STEP model to execute STEP-related tasks outside of
32+
a library.
33+
file Path to the STEP file (*.step).
34+
----
35+
36+
== Examples
37+
38+
[discrete]
39+
=== Minify & Validate STEP File
40+
41+
.Command
42+
[source,bash]
43+
----
44+
./librepcb-cli open-step --minify --tesselate --save-to minified.step model.step
45+
----
46+
47+
.Output
48+
----
49+
Open STEP file 'model.step'...
50+
Perform minify...
51+
- Minified from 512,464 bytes to 313,374 bytes (-39%)
52+
Save to 'out.step'...
53+
Load model...
54+
Tesselate model...
55+
- Built 17616 vertices with 2 different colors
56+
SUCCESS
57+
----

0 commit comments

Comments
 (0)