lepton-cli(1)

πŸ“¦
version 1.9.18 Β· 2 versions
  • 1.9.18 Β· debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 1.9.16 Β· ubuntu jammy
, in debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– lepton-cli β€” the Lepton EDA Command-Line Utility πŸ’–

okay bestie, welcome to lepton-cli β€” manual section 1, and yes this is the 1.9.18.20220529 era of the page, so that's the vibe we're working with 🫢


✨ NAME ✨

lepton-cli β€” the Lepton EDA Command-Line Utility. that's it, that's the name, she's iconic πŸ’…


🌸 SYNOPSIS 🌸

lepton-cli [OPTION ...] COMMAND [ARGS ...]

πŸ¦‹ DESCRIPTION πŸ¦‹

so lepton-cli is part of the Lepton EDA (Electronic Design Automation) toolset, no cap. it hands you a lil bundle of small command-line utilities for working with schematic and symbol files, and it's literally designed for batch processing of designs you made with the schematic editor lepton-schematic(1). main character energy fr fr.

right now she ships with three built-in COMMANDs:

  • lepton-cli export β€” this one creates SVG, PDF, PNG, PS and EPS files from schematic and symbol files, for printing or for embedding in other documents. obsessed.
  • lepton-cli config β€” lets you read and write settings in the Lepton EDA project, user and system configuration stores. the settings whisperer πŸ’œ
  • lepton-cli shell β€” provides a Scheme REPL for command-line batch processing of schematic data. yes queen, a whole REPL πŸŽ€

⭐ GENERAL OPTIONS ⭐

  • --no-rcfiles β€” stops gafrc Scheme initialisation files from being loaded. bye bestie πŸ™ˆ
  • -h, --help β€” prints a help message.
  • -V, --version β€” prints lepton-cli version information.

πŸ”₯ EXPORTING IMAGE FILES πŸ”₯

lepton-cli export [OPTION ...] -o OUTPUT [--] FILE ...

lepton-cli export can export schematic and symbol files in a whole variety of image formats, whether you're printing them or processing them further. as of rn it supports single-page PNG, SVG and EPS output, plus multi-page PS and PDF output. and she accepts a bunch of options for controlling exactly how the output gets formatted. so many knobs, so much power ✨

  • -o, --output=FILE β€” outputs the generated image data to FILE.
  • -f, --format=(png | pdf | svg | ps | eps) β€” specify an output format. usually you don't even need this option, because lepton-cli export will infer the correct format from the file extension of the output file. she's smart like that πŸ’…
  • -p, --paper=NAME β€” sizes the output for a particular paper size. the NAME should be a PWG 5101.1-2002 paper name. for example, valid values include iso_a4, na_letter, or na_d.
  • -P, --paper-names β€” prints paper size names suitable to pass to the --paper option, then exits. a little menu, a little snack πŸ“
  • -l, --layout=(auto | landscape | portrait) β€” when you're using a paper size, this sets the orientation of the output. if auto layout is used, whichever orientation best fits the drawing gets used.
  • -s, --size=(auto | WIDTH:HEIGHT) β€” sizes the output with specific dimensions. if the size is auto, she picks the size that best fits the drawing.
  • -k, --scale=FACTOR Set the output scale FACTOR. β€” this is a distance identical with 100 points (1 default grid spacing) in lepton-schematic(1) coordinate space. it's used to size the output when neither --paper nor --size are given, and it defaults to 100 mil.
  • -m, --margins=(auto | TOP[:LEFT[:BOTTOM[:RIGHT]]]) β€” sets the widths of the margins to be used. if auto margins are specified, a sensible default value will be chosen. up to four margin widths can be provided:
    • if one is provided, it will be used on all four sides.
    • if two are provided, the first will be used for the top/bottom and the second for the left/right.
    • if three are provided, the first will be used for the top, the second for left/right, and the third for the bottom.
  • -a, --align=(auto | HALIGN:VALIGN) β€” sets how the drawing is aligned within the page. HALIGN controls the horizontal alignment, and VALIGN the vertical. each alignment value should be in the range 0.0 to 1.0. the auto alignment is equivalent to a value of 0.5:0.5, i.e. centered. perfect centering, we love to see it 🫢
  • -d, --dpi=DPI β€” sets the number of pixels per inch used when generating PNG output.
  • -c, --color β€” enables colour output. 🌈
  • --no-color β€” disables color output.
  • -F, --font=FONT-FAMILY β€” sets the font to be used for drawing text.
  • -- β€” treats all remaining arguments as schematic or symbol filenames. use this if you have a schematic or symbol filename which begins with -. sneaky little dash filenames, not today 😭

the --size, --margins, or --scale options described above accept values using units of mm, cm, in, pc, px, or pt. if you do not provide a unit, points are assumed. n.b. that px are evaluated relative to the current --dpi setting. noted, bestie πŸ“

when using the --size, --margins, or --align options with multiple values, you may use ;, or as a separator between them instead of :. in such a case, remember to properly quote your arguments to avoid them to be interpreted by your shell. > no seriously, quote them β€” your shell is nosy and will absolutely eat your arguments πŸ’€


πŸŽ€ ACCESSING CONFIGURATION πŸŽ€

lepton-cli config [OPTION] [GROUP KEY [VALUE]]

lepton-cli config is a basic utility for inspecting and modifying Lepton EDA configuration stores. simple, effective, does her job πŸ’…

if a GROUP and KEY are specified, it retrieves the value of that configuration parameter. if a VALUE is specified, it sets the value of that parameter. the -p, -u and -s options can be used to select the configuration store affected (by default, the project configuration store for the current working directory). and if no GROUP and KEY are provided, it outputs the filename of the selected configuration store. peek behind the curtain ✨

  • -p [PATH], --project[=PATH] β€” selects the project configuration store of the project located in PATH. if no PATH is provided, it selects the project in the current working directory. unlike --project, for which an optional argument must be specified using =, any argument after -p is considered to be a path, not a configuration group. it may be specified as -pPATH or -p PATH.
  • -u, --user β€” selects the user configuration store.
  • -s, --system β€” selects the system configuration store. depending on user permissions, the system configuration store may be read-only. > heads up: read-only means read-only, don't fight her πŸ™ˆ
  • -c, --cache β€” selects the program-specific configuration store (CACHE configuration context, associated with $XDG_CACHE_HOME/lepton-eda/gui.conf configuration file).

🧚 SCHEME PROCESSING 🧚

lepton-cli shell [OPTION ...]

lepton-cli shell provides a Scheme Read-Eval-Print Loop (REPL) for automating processing of schematic and symbol files. she's designed to be used with the Lepton EDA Scheme API. automation queen πŸ‘‘

  • -s FILE β€” evaluates Scheme source code from FILE, and exits.
  • -c EXPR β€” evaluates the Scheme expression EXPR, and exits.
  • -- β€” stops scanning arguments; runs interactively.
  • -L DIRECTORY β€” prepends DIRECTORY to the list of directories to be searched for Scheme files.
  • -l FILE β€” evaluates Scheme source code from FILE.

the -s, -c and -- switches stop argument processing and pass all the remaining arguments as the value of (command-line). iykyk 🫢


πŸ’œ AUTHORS πŸ’œ

see the AUTHORS file included with this program. the whole squad is in there, go say hi πŸ₯°


Copyright Β© 2012-2017 gEDA Contributors. Copyright Β© 2017-2022 Lepton Developers. License GPLv2+: GNU GPL version 2 or later. Please see the COPYING file included with this program for full details.

this is free software: you are free to change and redistribute it. there is NO WARRANTY, to the extent permitted by law. > like, genuinely none. no cap. fr fr πŸ’€


🌈 SEE ALSO 🌈

for more information on the Scheme API, see the lepton-scheme Texinfo manual. if the info program is properly installed at your site, the command

info lepton-scheme

should give you access to the complete manual. go read it bestie, it's giving ✨educational✨


okay that's the whole page, and as a lil sign-off: this beauty comes to you from Lepton EDA, dated May 29, 2022 β€” and that's on the lepton-cli(1) manual page, periodt πŸ’–πŸŒΈπŸ¦‹