Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Command line

stitch is StitchCraft’s command-line tool. Each section shows the command’s own --help.

stitch

stitch: the StitchCraft command-line tool

Usage: stitch <COMMAND>

Commands:
  plan        Plan a design, an SVG file or a VectorCraft document, for a machine and write the machine file, with a picture and a report if asked [alias: export]
  testsheet   Write a machine-checkpoint test sheet (docs/src/plan/machine-testing.md)
  inspect     Read a machine file (PES, PEC or DST) and describe it: size, stitches, threads, stitch lengths
  preview     Draw a machine file (PES, PEC or DST) as a picture of what it will sew (PNG)
  convert     Write a machine file (PES, PEC or DST) in another format
  profiles    List the built-in machine profiles
  explain     Explain a diagnostic code, such as SC-W0702
  bug-report  Write a bug-report bundle that reproduces what StitchCraft does with a design, or replay one
  help        Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help

  -V, --version
          Print version

Exit status: 0 done (warnings allowed) · 1 the design or file has errors (nothing written) · 2 usage
error · 3 a file could not be read or written · 4 a bug in StitchCraft (a bug-report bundle is written
where it can be: see `stitch bug-report`).

stitch plan

Plan a design, an SVG file or a VectorCraft document, for a machine and write the machine file, with a picture and a report if asked

Usage: stitch plan [OPTIONS] --output <OUTPUT> <DESIGN>

Arguments:
  <DESIGN>
          The design: an SVG file, or a VectorCraft document (.vectorcraft)

Options:
  -o, --output <OUTPUT>
          The machine file to write

  -p, --profile <PROFILE>
          The machine profile (see `stitch profiles`); by default the one a VectorCraft document keeps, which StitchCraft's Design Settings filter sets, or else the reference machine, which `stitch profiles` lists first

      --format <FORMAT>
          The file format; by default the output file's extension decides

          Possible values:
          - pes: Brother PES, version 1
          - dst: Tajima DST

      --preview <PREVIEW>
          Also draw a picture of what the file will sew (PNG)

      --report <REPORT>
          Also write a report of the plan and what was said about it (JSON), even when nothing else is written

      --auto
          Digitize automatically the shapes that have no settings: StitchCraft chooses the stitches of each by its width (docs/src/design/image-to-embroidery.md). A shape with settings is left to them

      --sort-colours
          Sew the shapes with settings in the order StitchCraft chooses too, as --auto sews the shapes it digitizes: shapes that overlap keep their paint order, and each thread then sews as long as it can, the nearest shape next (docs/src/design/image-to-embroidery.md)

  -h, --help
          Print help (see a summary with '-h')

stitch testsheet

Write a machine-checkpoint test sheet (docs/src/plan/machine-testing.md)

Usage: stitch testsheet [OPTIONS] [SHEET]

Arguments:
  [SHEET]
          The sheet, such as TS-01 (see --list)

Options:
      --list
          List the test sheets and exit

  -p, --profile <PROFILE>
          The machine profile to check the sheet against (see `stitch profiles`); by default the one for the hoop the sheet is sewn in

  -o, --output <OUTPUT>
          The file to write

      --format <FORMAT>
          The file format; by default the output file's extension decides

          Possible values:
          - pes: Brother PES, version 1
          - dst: Tajima DST

  -h, --help
          Print help (see a summary with '-h')

stitch inspect

Read a machine file (PES, PEC or DST) and describe it: size, stitches, threads, stitch lengths

Usage: stitch inspect [OPTIONS] <FILE>

Arguments:
  <FILE>
          The machine file

Options:
  -p, --profile <PROFILE>
          Also check the design against a machine profile (see `stitch profiles`)

  -h, --help
          Print help

stitch preview

Draw a machine file (PES, PEC or DST) as a picture of what it will sew (PNG)

Usage: stitch preview [OPTIONS] --output <OUTPUT> <FILE>

Arguments:
  <FILE>
          The machine file

Options:
  -o, --output <OUTPUT>
          The picture to write (PNG)

      --style <STYLE>
          How the picture looks

          Possible values:
          - realistic: The finished embroidery on fabric, with the jump threads the machine leaves for you to cut
          - simple:    Every stitch, needle hole, move, trim and stop, for checking a design
          
          [default: realistic]

      --scale <SCALE>
          Pixels per millimetre
          
          [default: 8]

  -h, --help
          Print help (see a summary with '-h')

stitch convert

Write a machine file (PES, PEC or DST) in another format

Usage: stitch convert [OPTIONS] --output <OUTPUT> <FILE>

Arguments:
  <FILE>
          The machine file to read

Options:
  -o, --output <OUTPUT>
          The file to write

      --format <FORMAT>
          The file format; by default the output file's extension decides

          Possible values:
          - pes: Brother PES, version 1
          - dst: Tajima DST

  -h, --help
          Print help (see a summary with '-h')

stitch profiles

List the built-in machine profiles

Usage: stitch profiles

Options:
  -h, --help
          Print help

stitch explain

Explain a diagnostic code, such as SC-W0702

Usage: stitch explain <CODE>

Arguments:
  <CODE>
          The code

Options:
  -h, --help
          Print help

stitch bug-report

Write a bug-report bundle that reproduces what StitchCraft does with a design, or replay one.

The bundle is one file to attach to an issue, and it holds the design. With --replay, plan a bundle's design again and compare; the exit status is 1 when it does not reproduce.

Usage: stitch bug-report [OPTIONS] [DESIGN]

Arguments:
  [DESIGN]
          The design StitchCraft gets wrong: an SVG file, or a VectorCraft document (.vectorcraft)

Options:
      --replay <REPLAY>
          Replay this bundle instead: plan its design again, with the profile and format it names, and say whether everything comes out the same

  -o, --output <OUTPUT>
          The bundle to write; by default next to the design, as DESIGN.bug-report.json

  -p, --profile <PROFILE>
          The machine profile (see `stitch profiles`); by default the one a VectorCraft document keeps, which StitchCraft's Design Settings filter sets, or else the reference machine, which `stitch profiles` lists first

      --format <FORMAT>
          The file format; by default the profile's

          Possible values:
          - pes: Brother PES, version 1
          - dst: Tajima DST

      --says <SAYS>
          What goes wrong, in your words; it goes into the bundle

      --auto
          Digitize automatically the shapes that have no settings: StitchCraft chooses the stitches of each by its width (docs/src/design/image-to-embroidery.md). A shape with settings is left to them

      --sort-colours
          Sew the shapes with settings in the order StitchCraft chooses too, as --auto sews the shapes it digitizes: shapes that overlap keep their paint order, and each thread then sews as long as it can, the nearest shape next (docs/src/design/image-to-embroidery.md)

  -h, --help
          Print help (see a summary with '-h')

stitch help

Print this message or the help of the given subcommand(s)

Usage: stitch help [COMMAND]...

Arguments:
  [COMMAND]...
          Print help for the subcommand(s)