Command line
Every command takes --json: one JSON object instead of text (see Scripting). chipload --help and chipload COMMAND --help print the same help in the terminal.
chipload inspect
Dump units, entities, contours and issues of a DXF or a project
chipload inspect <FILE> [OPTIONS]
| Argument | Meaning |
|---|---|
<FILE> | A .dxf drawing or a .chipload project. |
--units <UNITS> | Units of a DXF that does not declare them. One of: mm, inch. |
chipload new
Create an empty project, to draw in or import a DXF into later (update --from)
chipload new [OPTIONS]
| Argument | Meaning |
|---|---|
-o, --output <OUTPUT> | The project to write (.chipload) Required. |
--machine <MACHINE> | The machine profile to start from (default: your default machine) |
chipload import
Create a project from a DXF
chipload import <DXF> [OPTIONS]
| Argument | Meaning |
|---|---|
<DXF> | The DXF. |
--units <UNITS> | Units of a DXF that does not declare them. One of: mm, inch. |
-o, --output <OUTPUT> | The project to write (.chipload) Required. |
--machine <MACHINE> | The machine profile to start from (default: your default machine) |
chipload update
Replace a project’s imported drawing with a new version of the DXF
chipload update <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--from <FROM> | The new DXF. Required. |
--units <UNITS> | Units of the new DXF, if they differ from the last import. One of: mm, inch. |
--dxf <DXF> | Which DXF of the project (as dxf list shows); needed when it has several. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload plan
Plan a project’s toolpath without writing G-code
chipload plan <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--set <PATH=VALUE> | For this run only: set a project value by path, e.g. stock.thickness=18 (see chipload set). The project file isn’t changed. Repeatable. |
chipload run
Generate checked G-code from a project
chipload run <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
-o, --output <OUTPUT> | Where to write the G-code. With several tools and one file per tool: part.nc gives part-1-T1.nc, part-2-T2.nc, … Required. |
--tool-change <TOOL_CHANGE> | For this run only: one file per tool, or one file with M6 tool changes (default: the project’s machine setting) One of: files (One G-code file per tool group), program (One file with T<n> M6 at each tool change). |
--no-sheet | Don’t write the setup sheet (by default part-sheet.html next to part.nc) |
--sheet-units <UNITS> | The setup sheet’s lengths and feeds: mm (default) or inch. The G-code’s units are the machine’s (machine.gcode_units) One of: mm, inch. |
--sheet-lang <LANG> | The setup sheet’s language (default: English). The command line itself stays English. One of: en, de, fr, es, it, sv. |
--set <PATH=VALUE> | For this run only: set a project value by path, e.g. stock.thickness=18 (see chipload set). The project file isn’t changed. Repeatable. |
chipload simulate
Simulate the material a project’s program removes (docs/specs/simulation.md): print the numbers and write a shaded top view (PNG). The job is generated and checked as by run; no G-code is written
chipload simulate <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
-o, --output <OUTPUT> | Where to write the image (.png); default: the project’s name with -sim.png. |
--cell <CELL> | Cell size, mm (default: automatic, from the stock’s size) |
--no-image | Print the numbers only. |
--after <N> | The stock after only the first N moves of the program (docs/specs/playback.md §5), for tests and scripts. |
--set <PATH=VALUE> | For this run only: set a project value by path, e.g. stock.thickness=18 (see chipload set). The project file isn’t changed. Repeatable. |
chipload sheet
Write a project’s setup sheet for the operator (HTML), without the G-code. The job is generated and checked as by run
chipload sheet <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
-o, --output <OUTPUT> | Where to write the sheet (.html) Required. |
--gcode <GCODE> | The G-code the sheet is for, as given to run -o, for its file names (default: the project’s name with the post’s extension) |
--tool-change <TOOL_CHANGE> | For this sheet only: one file per tool, or one file with M6 tool changes. One of: files (One G-code file per tool group), program (One file with T<n> M6 at each tool change). |
--units <UNITS> | Its lengths and feeds: mm (default) or inch. The G-code’s units are the machine’s (machine.gcode_units) One of: mm, inch. |
--lang <LANG> | Its language (default: English). The command line itself stays English. One of: en, de, fr, es, it, sv. |
--set <PATH=VALUE> | For this run only: set a project value by path, e.g. stock.thickness=18 (see chipload set). The project file isn’t changed. Repeatable. |
chipload render
Render a toolpath JSON (as plan --json prints under “program”) through a post-processor. For testing posts; the output is NOT checked, use run to cut
chipload render <PROGRAM> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROGRAM> | Toolpath JSON file. |
--post <POST> | Built-in post-processor. Default: grbl. |
chipload check
Check a G-code program against a project’s stock, safe height and machine limits
chipload check <GCODE> [OPTIONS]
| Argument | Meaning |
|---|---|
<GCODE> | G-code file to check. |
--job <JOB> | The project (or job) the program was generated from. Required. |
--tool <TOOL> | The project’s tool that cuts this program, for its stock margin (one file of a set written one file per tool). Default: the largest tool the project uses. |
chipload op
Change an operation of a project
chipload op tool
Set the tool an operation cuts with (docs/specs/tool-per-operation.md §7). The tool must be in the project: copy one in from your library with tool use
chipload op tool <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--op <OP> | The operation’s number as the app lists it (1 = first; get and set paths count from 0) Required. |
--tool <TOOL> | The tool’s id in the project. Required. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload op add-rest
Add a rest pass to a pocket (docs/specs/rest-passes.md): a smaller endmill that clears what the pocket’s tool (or its last pass’s) leaves, in the pocket’s shapes and depths. It is cut after the run of pockets with the pocket’s tool
chipload op add-rest <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--op <OP> | The pocket’s number as the app lists it (1 = first; get and set paths count from 0) Required. |
--tool <TOOL> | The smaller tool’s id in the project. Required. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload op add-surface
Add a surface (docs/specs/surfacing.md): the whole stock taken down flat with a wide endmill, in straight passes back and forth, first in the active part. Flattens the spoilboard or faces the stock
chipload op add-surface <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--tool <TOOL> | The endmill’s id in the project; default: the widest endmill. |
--depth <DEPTH> | How much comes off the top; default 0.5 mm. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload op rest-pass
A pocket’s rest passes (docs/specs/rest-passes.md): without –pass, list them; with it, change, turn off or on, or remove one
chipload op rest-pass <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--op <OP> | The pocket’s number as the app lists it (1 = first) Required. |
--pass <PASS> | Which pass: 1 for the first (shown as 3.1 for operation 3) |
--tool <TOOL> | The tool’s id in the project: an endmill smaller than the tool before it. |
--feed <FEED> | |
--plunge-feed <PLUNGE_FEED> | |
--step-down <STEP_DOWN> | |
--stepover <STEPOVER> | A fraction of the tool’s diameter, at most 1. |
--enabled <ENABLED> | Cut it (true) or keep it without cutting (false) One of: true, false. |
--remove | Remove the pass; the passes after it rest after the tool before it. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload op make-rest-pass
Make a rest pocket that copies an earlier pocket (same shapes, depths, clearance and direction, rest after its tool) a rest pass of that pocket (docs/specs/rest-passes.md §5). It is then cut after the run of pockets it belongs to
chipload op make-rest-pass <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--op <OP> | The rest pocket’s number as the app lists it (1 = first) Required. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload op part
Move an operation into another part, at the end of its operations (docs/specs/parts.md §7). Operations are numbered again in the new order
chipload op part <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--op <OP> | The operation’s number as the app lists it (1 = first; get and set paths count from 0) Required. |
--part <PART> | The part’s id (as part list shows it) Required. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload op corners
List a profile’s or pocket’s corners on the tool’s side, with what each gets (round, dogbone, T-bone along the longer or shorter wall) and whether that is the corner’s own choice (docs/specs/dogbone-per-corner.md)
chipload op corners <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--op <OP> | The operation’s number as the app lists it (1 = first) Required. |
chipload op corner
Give one corner of a profile or pocket its own bone, whatever the operation’s corners say (docs/specs/dogbone-per-corner.md): --bone none keeps it round. op corners lists the corners
chipload op corner <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--op <OP> | The operation’s number as the app lists it (1 = first) Required. |
--at <AT> | The corner, X,Y in drawing coordinates (a plain number is mm) |
--bone <BONE> | What the corner gets. One of: none, dogbone, tbone. |
--along <ALONG> | With a T-bone: the wall it runs along (the notch is in the other); default longer. One of: longer, shorter. |
--as-operation | Remove the corner’s own choice: it gets what the operation gives every corner. |
--reset | Remove every corner’s own choice. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload op tabs
List a profile’s tabs: each contour’s, with their centres on the tool path and whether they were placed by hand (docs/specs/tabs-by-hand.md). The job is planned
chipload op tabs <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--op <OP> | The operation’s number as the app lists it (1 = first) Required. |
chipload op tab
Place a profile’s tabs by hand (docs/specs/tabs-by-hand.md): add a tab at a point, or remove the one there. The first on a contour keeps that contour’s other tabs where Chipload put them. --even spaces one contour’s tabs evenly again, --reset all
chipload op tab <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--op <OP> | The operation’s number as the app lists it (1 = first) Required. |
--at <AT> | The point, X,Y in drawing coordinates (a plain number is mm): on or near the contour, within a tool diameter. |
--remove | Remove the tab nearest to –at. |
--even | Space the tabs of the contour nearest to –at evenly again. |
--reset | Space every contour’s tabs evenly again. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload op rest
Make a pocket clear only what a larger tool leaves (docs/specs/rest-machining.md)
chipload op rest <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--op <OP> | The pocket’s number as the app lists it (1 = first; get and set paths count from 0) Required. |
--after-tool <AFTER_TOOL> | The larger tool’s id in the project. |
--none | Clear the whole pocket again. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload shape
Draw in a project: add, change or delete circles, rectangles and polylines
chipload shape add
Add a drawn shape; prints its id
chipload shape add <PROJECT> <KIND> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<KIND> | One of: circle, rectangle, polyline. |
--center <CENTER> | Centre “X,Y” (circle, rectangle) |
--radius <RADIUS> | |
--length <LENGTH> | Along the rectangle’s own X axis. |
--width <WIDTH> | Along the rectangle’s own Y axis. |
--angle-deg <ANGLE_DEG> | Rotation about the centre, degrees, counter-clockwise. |
--corner-radius <CORNER_RADIUS> | The radius of the rectangle’s corners, at most half its shorter side (default 0: sharp) |
--points <POINTS> | Polyline points “X,Y X,Y …”. |
--bulges <BULGES> | Polyline bulges “B B …”, one per segment: tan(sweep / 4) as in DXF, 0 straight, 1 a counter-clockwise half circle, -1 clockwise (default: all straight) |
--open | The polyline doesn’t return to its first point. |
--closed | The polyline returns to its first point (the default for new ones) |
--layer <LAYER> | |
--name <NAME> | Its name in the Browser; “” takes the name away. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload shape set
Change a drawn shape’s values or layer; it keeps its id
chipload shape set <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The shape id (as inspect lists it, without the S) |
--center <CENTER> | Centre “X,Y” (circle, rectangle) |
--radius <RADIUS> | |
--length <LENGTH> | Along the rectangle’s own X axis. |
--width <WIDTH> | Along the rectangle’s own Y axis. |
--angle-deg <ANGLE_DEG> | Rotation about the centre, degrees, counter-clockwise. |
--corner-radius <CORNER_RADIUS> | The radius of the rectangle’s corners, at most half its shorter side (default 0: sharp) |
--points <POINTS> | Polyline points “X,Y X,Y …”. |
--bulges <BULGES> | Polyline bulges “B B …”, one per segment: tan(sweep / 4) as in DXF, 0 straight, 1 a counter-clockwise half circle, -1 clockwise (default: all straight) |
--open | The polyline doesn’t return to its first point. |
--closed | The polyline returns to its first point (the default for new ones) |
--layer <LAYER> | |
--name <NAME> | Its name in the Browser; “” takes the name away. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload shape remove
Remove a drawn shape. Operations that used it are flagged
chipload shape remove <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload shape copy
Copy drawn shapes, moved by –dx and –dy, on their layers; prints the new ids
chipload shape copy <PROJECT> <IDS>... [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<IDS> | The shape ids (as inspect lists them, without the S) |
--dx <DX> | How far to move the copies right, mm. Required. |
--dy <DY> | How far to move the copies up, mm. Required. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload shape mirror
Mirror drawn shapes in place, about the middle of the box round them. They keep their ids, so the operations that cut them follow
chipload shape mirror <PROJECT> <IDS>... [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<IDS> | The shape ids (as inspect lists them, without the S) |
--axis <AXIS> | x: flip the X coordinates (left becomes right); y: flip Y (up becomes down) One of: x, y. Required. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload shape move
Move drawn shapes by –dx and –dy; they keep their ids, so the operations that cut them follow (docs/specs/drawn-shapes-box.md)
chipload shape move <PROJECT> <IDS>... [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<IDS> | The shape ids (as inspect lists them, without the S) |
--dx <DX> | How far to move them right, mm. Required. |
--dy <DY> | How far to move them up, mm. Required. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload shape turn
Turn drawn shapes counter-clockwise about the middle of the box round them, or a point
chipload shape turn <PROJECT> <IDS>... [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<IDS> | The shape ids (as inspect lists them, without the S) |
--angle-deg <ANGLE_DEG> | The angle, degrees, counter-clockwise; negative turns clockwise. Required. |
--about <ABOUT> | Turn about this point “X,Y” instead. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload shape scale
Scale drawn shapes evenly about the middle of the box round them, or a point
chipload shape scale <PROJECT> <IDS>... [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<IDS> | The shape ids (as inspect lists them, without the S) |
--factor <FACTOR> | The factor, greater than 0: 2 doubles them. Required. |
--about <ABOUT> | Scale about this point “X,Y” instead. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload shape join
Join open drawn polylines whose ends are closer than –gap into one, on the same layer; a chain that comes back to its start closes (docs/specs/explode-and-join.md)
chipload shape join <PROJECT> <IDS>... [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<IDS> | The shape ids (as inspect lists them, without the S); none: every drawn shape. |
--gap <GAP> | Join ends closer than this, 0.001 to 1 mm. Default: 0.01. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload image
Pictures traced into shapes for V-carving: add, change, list, preview, remove
chipload image add
Add a picture (PNG, JPEG or BMP) and trace it into shapes on its own layer
chipload image add <PROJECT> <PICTURE> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<PICTURE> | The picture. |
--width <WIDTH> | The picture’s width on the stock, mm; its height follows. Required. |
--layer <LAYER> | The layer for its shapes; default: the picture’s file name. |
--invert | Carve the light parts instead of the dark ones. |
--at <AT> | Where the picture’s lower-left corner goes: X,Y in mm (default 0,0) |
--threshold <THRESHOLD> | Grey values (0–255) below this are black: 1 to 254, or auto (default) |
--blur <BLUR> | Blur before the threshold, px, 0 to 10 (default 1) |
--min-area <MIN_AREA> | Drop specks smaller than this, mm², 0 to 100 (default 0.5) |
--smoothing <SMOOTHING> | How far an edge may be simplified, mm, 0.01 to 1 (default 0.05) |
--trace <TRACE> | What to trace: outline (for a V-carve, default) or centre-line (strokes, for a follow path) |
--arcs <ARCS> | Fit arcs as well as lines (true or false; default true) One of: true, false. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload image set
Change an image’s settings, position or size, and trace it again
chipload image set <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The image’s id (as image list shows it) |
--width <WIDTH> | The picture’s width on the stock, mm. |
--rotate <ROTATE> | Turn it about its centre to this angle, degrees counter-clockwise (any angle; 0: as the picture is). --at stays the corner before the turn. |
--layer <LAYER> | The layer for its shapes. |
--invert <INVERT> | Carve the light parts instead (true or false) One of: true, false. |
--at <AT> | Where the picture’s lower-left corner goes: X,Y in mm (default 0,0) |
--threshold <THRESHOLD> | Grey values (0–255) below this are black: 1 to 254, or auto (default) |
--blur <BLUR> | Blur before the threshold, px, 0 to 10 (default 1) |
--min-area <MIN_AREA> | Drop specks smaller than this, mm², 0 to 100 (default 0.5) |
--smoothing <SMOOTHING> | How far an edge may be simplified, mm, 0.01 to 1 (default 0.05) |
--trace <TRACE> | What to trace: outline (for a V-carve, default) or centre-line (strokes, for a follow path) |
--arcs <ARCS> | Fit arcs as well as lines (true or false; default true) One of: true, false. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload image list
The project’s images: picture, place, settings and shapes
chipload image list <PROJECT>
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
chipload image preview
Write an image as black and white, as it is traced (PNG)
chipload image preview <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The image’s id. |
-o, --output <OUTPUT> | The PNG to write. Required. |
chipload image remove
Remove an image and its shapes
chipload image remove <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The image’s id. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload text
Text written into shapes for V-carving, pocketing or profiling: add, change, list, remove, and the built-in fonts (docs/specs/text.md)
chipload text add
Write a text into shapes on its own layer; prints its id. “\n” in the text starts a new line
chipload text add <PROJECT> <TEXT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<TEXT> | What it says. |
--height <HEIGHT> | The height of a capital letter, mm. Required. |
--at <AT> | Where the text’s anchor goes: X,Y in mm (default 0,0) |
--anchor <ANCHOR> | What –at is: the lower-left corner of the text’s box (default) or its centre. A centred text stays centred when it changes. Changed without –at, the text stays where it is. One of: corner, center. |
--rotate <ROTATE> | Turn it about its centre to this angle, degrees counter-clockwise (any angle). --at stays the corner before the turn. |
--font <FONT> | A built-in font (text fonts; default FreeSans) |
--align <ALIGN> | How the lines line up (default left) One of: left, center, right. |
--spacing <SPACING> | Extra space between letters, mm (default 0: the font’s own) |
--line-spacing <LINE_SPACING> | From one line’s base to the next, in capital heights (default 1.6) |
--layer <LAYER> | The layer for its letters (default “text”) |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload text set
Change a text (what it says, its font, size, place or turn) and write it again
chipload text set <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The text’s id (as text list shows it) |
--text <TEXT> | What it says. |
--height <HEIGHT> | The height of a capital letter, mm. |
--at <AT> | Where the text’s anchor goes: X,Y in mm (default 0,0) |
--anchor <ANCHOR> | What –at is: the lower-left corner of the text’s box (default) or its centre. A centred text stays centred when it changes. Changed without –at, the text stays where it is. One of: corner, center. |
--rotate <ROTATE> | Turn it about its centre to this angle, degrees counter-clockwise (any angle). --at stays the corner before the turn. |
--font <FONT> | A built-in font (text fonts; default FreeSans) |
--align <ALIGN> | How the lines line up (default left) One of: left, center, right. |
--spacing <SPACING> | Extra space between letters, mm (default 0: the font’s own) |
--line-spacing <LINE_SPACING> | From one line’s base to the next, in capital heights (default 1.6) |
--layer <LAYER> | The layer for its letters (default “text”) |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload text list
The project’s texts: what they say, font, size, place and shapes
chipload text list <PROJECT>
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
chipload text remove
Remove a text and its letters
chipload text remove <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The text’s id. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload text fonts
The built-in fonts
chipload text fonts
chipload dxf
A project’s DXFs: add another, list them, remove one (docs/specs/drawing-sources.md)
chipload dxf add
Add a DXF to the project, where the file has it; move it with place --dxf ID
chipload dxf add <PROJECT> <DXF> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<DXF> | The DXF. |
--units <UNITS> | The DXF’s units, if it doesn’t say. |
--name <NAME> | Its name; default: the file’s name without its extension. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload dxf list
The project’s DXFs: id, name, file, placement and shapes
chipload dxf list <PROJECT>
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
chipload dxf explode
Turn a DXF’s shapes into drawn shapes you can edit; the project no longer knows the DXF (docs/specs/explode-and-join.md). Operations keep cutting the same shapes
chipload dxf explode <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The DXF’s id (as dxf list shows it); not needed when the project has one. |
--join <JOIN> | Then join ends closer than this (as shape join --gap), e.g. 0.01 or 0.05mm. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload dxf remove
Remove a DXF and its shapes
chipload dxf remove <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The DXF’s id (as dxf list shows it) |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload tool
Your tool library: tools kept for every project (copied into a project when used)
chipload tool export
Write the tools to a file: a backup, or for another computer
chipload tool export <FILE> [OPTIONS]
| Argument | Meaning |
|---|---|
<FILE> | |
--name <NAMES> | Only these (repeatable); default: all. Repeatable. |
chipload tool import
Add the tools of an exported file (or another computer’s library file)
chipload tool import <FILE> [OPTIONS]
| Argument | Meaning |
|---|---|
<FILE> | |
--replace | Overwrite yours where the file has other values under the same name. |
chipload tool list
List the library’s tools and where the library is
chipload tool list
chipload tool add
Add a tool to the library
chipload tool add <NAME> [OPTIONS]
| Argument | Meaning |
|---|---|
<NAME> | |
--type <KIND> | One of: endmill, drill, vbit. |
--diameter <DIAMETER> | |
--flutes <FLUTES> | |
--center-cutting <CENTER_CUTTING> | One of: yes, no. |
--rpm <RPM> | |
--angle <ANGLE> | V-bits: the included angle, degrees. |
--tip <TIP> | V-bits: the diameter of the flat tip, mm (0: pointed) |
--id <ID> | The id it gets in a project where that id is free (default 1) |
--feed <FEED> | Cutting values for new operations: give all four the first time. |
--plunge-feed <PLUNGE_FEED> | |
--step-down <STEP_DOWN> | |
--stepover <STEPOVER> | Fraction of the tool diameter (pockets) |
chipload tool set
Change a library tool
chipload tool set <NAME> [OPTIONS]
| Argument | Meaning |
|---|---|
<NAME> | |
--type <KIND> | One of: endmill, drill, vbit. |
--diameter <DIAMETER> | |
--flutes <FLUTES> | |
--center-cutting <CENTER_CUTTING> | One of: yes, no. |
--rpm <RPM> | |
--angle <ANGLE> | V-bits: the included angle, degrees. |
--tip <TIP> | V-bits: the diameter of the flat tip, mm (0: pointed) |
--id <ID> | The id it gets in a project where that id is free (default 1) |
--feed <FEED> | Cutting values for new operations: give all four the first time. |
--plunge-feed <PLUNGE_FEED> | |
--step-down <STEP_DOWN> | |
--stepover <STEPOVER> | Fraction of the tool diameter (pockets) |
--rename <RENAME> | A new name. |
chipload tool remove
Remove a tool from the library
chipload tool remove <NAME>
| Argument | Meaning |
|---|---|
<NAME> |
chipload tool default
The tool new projects start with
chipload tool default <NAME>
| Argument | Meaning |
|---|---|
<NAME> |
chipload tool use
Copy a library tool into a project; prints its id there
chipload tool use <NAME> <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<NAME> | |
<PROJECT> | The project (.chipload) |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload tool compare
How each project tool stands to the library tool it came from: same, differs (with the differences), missing, or none
chipload tool compare <PROJECT>
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
chipload tool save
Save a project’s tool into the library; the project’s tool is linked to it
chipload tool save <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--tool <TOOL> | The tool id in the project. Required. |
--name <NAME> | Its name in the library. Required. |
--replace | Overwrite a library tool of that name. |
chipload machine
Your machine profiles: machine values a new project starts with
chipload machine export
Write the machine profiles to a file: a backup, or for another computer
chipload machine export <FILE> [OPTIONS]
| Argument | Meaning |
|---|---|
<FILE> | |
--name <NAMES> | Only these (repeatable); default: all. Repeatable. |
chipload machine import
Add the machine profiles of an exported file (or another computer’s library file)
chipload machine import <FILE> [OPTIONS]
| Argument | Meaning |
|---|---|
<FILE> | |
--replace | Overwrite yours where the file has other values under the same name. |
chipload machine list
List the machine profiles and where they are kept
chipload machine list
chipload machine add
Add a machine profile. Values not given are the built-in project defaults
chipload machine add <NAME> [OPTIONS]
| Argument | Meaning |
|---|---|
<NAME> | |
--post <POST> | Built-in post-processor. |
--safe-z <SAFE_Z> | |
--spindle <SPINDLE> | One of: cw, ccw. |
--max-feed <MAX_FEED> | |
--travel <TRAVEL> | Travel “X,Y,Z”. |
--work-zero <WORK_ZERO> | drawing-origin, stock-center, stock-bottom-left, stock-bottom-right, stock-top-left, stock-top-right, or a point “X,Y”. |
--max-overcut <MAX_OVERCUT> | How far below the stock a cut may go (into the spoilboard) |
--tool-change <TOOL_CHANGE> | With several tools: one G-code file per tool, or one file with M6 tool changes that your sender handles. One of: files (One G-code file per tool group), program (One file with T<n> M6 at each tool change). |
--gcode-units <GCODE_UNITS> | The units the G-code is written in: mm (G21) or inch (G20). Everything else stays in mm. One of: mm, inch. |
chipload machine set
Change a machine profile
chipload machine set <NAME> [OPTIONS]
| Argument | Meaning |
|---|---|
<NAME> | |
--post <POST> | Built-in post-processor. |
--safe-z <SAFE_Z> | |
--spindle <SPINDLE> | One of: cw, ccw. |
--max-feed <MAX_FEED> | |
--travel <TRAVEL> | Travel “X,Y,Z”. |
--work-zero <WORK_ZERO> | drawing-origin, stock-center, stock-bottom-left, stock-bottom-right, stock-top-left, stock-top-right, or a point “X,Y”. |
--max-overcut <MAX_OVERCUT> | How far below the stock a cut may go (into the spoilboard) |
--tool-change <TOOL_CHANGE> | With several tools: one G-code file per tool, or one file with M6 tool changes that your sender handles. One of: files (One G-code file per tool group), program (One file with T<n> M6 at each tool change). |
--gcode-units <GCODE_UNITS> | The units the G-code is written in: mm (G21) or inch (G20). Everything else stays in mm. One of: mm, inch. |
--rename <RENAME> | A new name. |
chipload machine remove
Remove a machine profile
chipload machine remove <NAME>
| Argument | Meaning |
|---|---|
<NAME> |
chipload machine default
The machine new projects start with
chipload machine default <NAME>
| Argument | Meaning |
|---|---|
<NAME> |
chipload machine use
Copy a profile’s values into a project; lists what changed
chipload machine use <NAME> <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<NAME> | |
<PROJECT> | The project (.chipload) |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload machine compare
How the project’s machine stands to the profile it came from: same, differs (with the differences), missing, or none
chipload machine compare <PROJECT>
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
chipload machine save
Save a project’s machine values as a profile; the project is linked to it
chipload machine save <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--name <NAME> | The profile’s name. Required. |
--replace | Overwrite a profile of that name. |
chipload post
Post-processors: the built-in ones and yours (docs/specs/user-posts.md)
chipload post list
List the built-in post-processors and yours, and where yours go
chipload post list
chipload post show
What a post-processor writes: its name, files, extension, decimals, arcs, tool change modes and spindle dwell
chipload post show <NAME>
| Argument | Meaning |
|---|---|
<NAME> | The post’s name (chipload post list) |
chipload post use
Make a post-processor the project’s; one of yours is copied into the project (run again after changing it, to update the copy)
chipload post use <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--post <POST> | The post’s name (chipload post list) Required. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload part
A project’s parts: groups of operations, each cut with its copies before the next (docs/specs/parts.md)
chipload part list
The project’s parts: id, name, on or off, copies and operations
chipload part list <PROJECT>
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
chipload part add
Add an empty part at the end; it becomes the active part
chipload part add <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--name <NAME> | Its name; default: “Part N”. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload part set
Rename a part, or turn it off or on (a part that is off isn’t cut)
chipload part set <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The part’s id (as part list shows it) |
--name <NAME> | Its new name. |
--off | Leave the part and its operations out of the program. |
--on | Cut the part again. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload part activate
Make a part the active one: where the app adds new operations
chipload part activate <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The part’s id. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload part remove
Remove a part. Refused while it has operations, unless –with-operations
chipload part remove <PROJECT> <ID> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<ID> | The part’s id. |
--with-operations | Remove its operations with it. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload copies
Cut a part several times in a grid (docs/specs/copies-grid.md)
chipload copies <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--part <PART> | Which part (as part list shows it); needed when the project has several. |
--grid <GRID> | Columns x rows, e.g. “3x2”. |
--pitch <PITCH> | Pitch “DX,DY” in mm, copy to copy; negative grows left or down. |
--gap <GAP> | Set the pitch so that this many mm are left between the cuts of neighbours. |
--order <ORDER> | The cut order. One of: by-operation (Each operation on every copy, then the next operation), by-copy (Every operation on one copy, then the next copy (was by-part)). |
--off | Back to one copy. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload place
Move, turn or scale the imported drawing (docs/specs/drawing-placement.md, drawing-rotation.md, drawing-scale.md). Without an option, print where it is
chipload place <PROJECT> [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
--by <BY> | Move by “DX,DY” mm. |
--to <TO> | Put it “DX,DY” mm from where the DXF has it; 0,0 is as drawn. |
--at <AT> | Put the lower-left corner of its bounding box at “X,Y” mm (the app’s Position) |
--align <ALIGN> | Align the drawing’s extent with the stock. One of: bottom-left (Bottom-left corner on the stock’s, –margin mm in), center (Centre on the stock’s centre). |
--margin <MARGIN> | With –align bottom-left: how far in from the stock’s corner, mm. |
--rotate <ROTATE> | Turn it about its centre by this many degrees counter-clockwise (negative: clockwise), any angle, on top of any turn it has. Before –align when both are given. |
--scale <SCALE> | Scale it about its centre by this factor (> 0), on top of any scale it has. After –rotate, before –align. |
--width <WIDTH> | Scale it about its centre until it is this wide, mm (the height follows) |
--height <HEIGHT> | Scale it about its centre until it is this high, mm (the width follows) |
--reset | Back to where the DXF has it: no turn, no scale, no move. |
--dxf <DXF> | Which DXF of the project (as dxf list shows); needed when it has several. |
--image <IMAGE> | A picture of the project instead (as image list shows it): –at, –rotate and –width apply, as image set. |
--text <TEXT> | A text of the project instead (as text list shows it): –at (its anchor: the corner or the centre, as set), –rotate and –height (its capital height) apply, as text set. |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload licenses
Print Chipload’s licence and the licences of every third-party component
chipload licenses
chipload get
Print a project value by path, as JSON (docs/specs/scripting.md §4), e.g. operations.1.end_depth: keys and indexes from 0, as in the file
chipload get <PROJECT> <PATH>
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<PATH> |
chipload set
Set project values by path (docs/specs/scripting.md §4): operations.1.end_depth=6.5. A value is JSON when it parses (6.5, true, null, {“after_tool”: 1}), else text. The project must still load; problems are listed but don’t stop the write
chipload set <PROJECT> <VALUES>... [OPTIONS]
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
<VALUES> | |
-o, --output <OUTPUT> | Where to write the result; default: the project itself. |
chipload check-project
List a project’s problems with their paths, without planning; exits 1 if any
chipload check-project <PROJECT>
| Argument | Meaning |
|---|---|
<PROJECT> | The project (.chipload) |
chipload schema
Print the JSON Schema of a file format (docs/specs/scripting.md §2)
chipload schema <FORMAT>
| Argument | Meaning |
|---|---|
<FORMAT> | One of: project (A project file (.chipload)), tools (The tool library (tools.json, and tool export files)), machines (The machine profiles (machines.json, and machine export files)). |
chipload mcp
Serve the commands as tools to an AI assistant over the Model Context Protocol, on stdin and stdout (e.g. claude mcp add chipload -- chipload mcp)
chipload mcp