Skip to content

Commit 0d5f75a

Browse files
ubruhinubruhin
committed
Update CLI documentation
1 parent 046f6c4 commit 0d5f75a

File tree

6 files changed

+89
-15
lines changed

6 files changed

+89
-15
lines changed

‎modules/cli/nav.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
** xref:installation.adoc[]
33
** xref:help.adoc[]
44
** xref:open-library.adoc[]
5+
** xref:open-symbol.adoc[]
6+
** xref:open-package.adoc[]
57
** xref:open-project.adoc[]
68
** xref:open-step.adoc[]

‎modules/cli/pages/help.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ Arguments:
2323
2424
Commands:
2525
open-library Open a library to execute library-related tasks.
26+
open-package Open a package to execute package-related tasks.
2627
open-project Open a project to execute project-related tasks.
2728
open-step Open a STEP model to execute STEP-related tasks outside of a library.
29+
open-symbol Open a symbol to execute symbol-related tasks.
2830
2931
List command-specific options:
3032
./librepcb-cli <command> --help

‎modules/cli/pages/open-library.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Arguments:
3838
== Examples
3939

4040
[discrete]
41-
=== Check Library Elements and Upgrade File Format
41+
=== Check Library Elements
4242

4343
This command is useful for Continuous Integration of LibrePCB libraries because
4444
it reports failure if you check in libraries with invalid or non-canonical

‎modules/cli/pages/open-package.adoc‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
= Command "open-package"
2+
3+
This command opens a LibrePCB package and lets you execute some tasks with it.
4+
5+
.Command
6+
[source,bash]
7+
----
8+
./librepcb-cli open-package --help
9+
----
10+
11+
.Output
12+
----
13+
Usage: ./librepcb-cli [options] open-package [command_options] package
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+
--check Run the package check, print all non-approved messages and
21+
report failure (exit code = 1) if there are non-approved
22+
messages.
23+
--export <file> Export the contained footprint(s) to a graphical file.
24+
Supported file extensions: pdf, svg, bmp, cur, icns, ico,
25+
jfif, jpeg, jpg, pbm, pgm, png, ppm, tif, tiff, wbmp, webp,
26+
xbm, xpm
27+
28+
Arguments:
29+
open-package Open a package to execute package-related tasks.
30+
package Path to package directory (containing *.lp).
31+
----

‎modules/cli/pages/open-project.adoc‎

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,37 +38,46 @@ Options:
3838
--outdir <path> Override the output base directory of
3939
jobs. If not set, the standard output
4040
directory from the project is used.
41-
--export-schematics <file> Export schematics to given file(s).
41+
--export-schematics <file> [DEPRECATED, REPLACED BY: --run-jobs]
42+
Export schematics to given file(s).
4243
Existing files will be overwritten.
4344
Supported file extensions: pdf, svg, bmp,
44-
cur, ico, jpeg, jpg, pbm, pgm, png, ppm,
45-
xbm, xpm
46-
--export-bom <file> Export generic BOM to given file(s).
45+
cur, icns, ico, jfif, jpeg, jpg, pbm, pgm,
46+
png, ppm, tif, tiff, wbmp, webp, xbm, xpm
47+
--export-bom <file> [DEPRECATED, REPLACED BY: --run-jobs]
48+
Export generic BOM to given file(s).
4749
Existing files will be overwritten.
4850
Supported file extensions: csv
49-
--export-board-bom <file> Export board-specific BOM to given
50-
file(s). Existing files will be
51-
overwritten. Supported file extensions: csv
52-
--bom-attributes <attributes> Comma-separated list of additional
51+
--export-board-bom <file> [DEPRECATED, REPLACED BY: --run-jobs]
52+
Export board-specific BOM to given file(s).
53+
Existing files will be overwritten.
54+
Supported file extensions: csv
55+
--bom-attributes <attributes> [DEPRECATED, REPLACED BY: --run-jobs]
56+
Comma-separated list of additional
5357
attributes to be exported to the BOM.
5458
Example: "SUPPLIER, SKU"
55-
--export-pcb-fabrication-data Export PCB fabrication data
59+
--export-pcb-fabrication-data [DEPRECATED, REPLACED BY: --run-jobs]
60+
Export PCB fabrication data
5661
(Gerber/Excellon) according the fabrication
5762
output settings of boards. Existing files
5863
will be overwritten.
59-
--pcb-fabrication-settings <file> Override PCB fabrication output settings
60-
by providing a *.lp file containing custom
64+
--pcb-fabrication-settings <file> [DEPRECATED, REPLACED BY: --jobs] Override
65+
PCB fabrication output settings by
66+
providing a *.lp file containing custom
6167
settings. If not set, the settings from the
6268
boards will be used instead.
63-
--export-pnp-top <file> Export pick&place file for automated
69+
--export-pnp-top <file> [DEPRECATED, REPLACED BY: --run-jobs]
70+
Export pick&place file for automated
6471
assembly of the top board side. Existing
6572
files will be overwritten. Supported file
6673
extensions: csv, gbr
67-
--export-pnp-bottom <file> Export pick&place file for automated
74+
--export-pnp-bottom <file> [DEPRECATED, REPLACED BY: --run-jobs]
75+
Export pick&place file for automated
6876
assembly of the bottom board side. Existing
6977
files will be overwritten. Supported file
7078
extensions: csv, gbr
71-
--export-netlist <file> Export netlist file for automated PCB
79+
--export-netlist <file> [DEPRECATED, REPLACED BY: --run-jobs]
80+
Export netlist file for automated PCB
7281
testing. Existing files will be
7382
overwritten. Supported file extensions:
7483
d356

‎modules/cli/pages/open-symbol.adoc‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
= Command "open-symbol"
2+
3+
This command opens a LibrePCB symbol and lets you execute some tasks with it.
4+
5+
.Command
6+
[source,bash]
7+
----
8+
./librepcb-cli open-symbol --help
9+
----
10+
11+
.Output
12+
----
13+
Usage: ./librepcb-cli [options] open-symbol [command_options] symbol
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+
--check Run the symbol check, print all non-approved messages and
21+
report failure (exit code = 1) if there are non-approved
22+
messages.
23+
--export <file> Export the symbol to a graphical file. Supported file
24+
extensions: pdf, svg, bmp, cur, icns, ico, jfif, jpeg, jpg,
25+
pbm, pgm, png, ppm, tif, tiff, wbmp, webp, xbm, xpm
26+
27+
Arguments:
28+
open-symbol Open a symbol to execute symbol-related tasks.
29+
symbol Path to symbol directory (containing *.lp).
30+
----

0 commit comments

Comments
 (0)