Command line tool

edea command line tool

edea.cli.check(project_or_file: ~pathlib.Annotated[~pathlib.Path, <typer.models.ArgumentInfo object at 0x7f7a3a321290>], custom_dr: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7f7a3a357f10>] = None, custom_dr_url: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f7a3a321910>] = None, drc: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f7a3a321750>] = True, erc: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f7a3a321250>] = True, ignore_regex: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7f7a3a321ad0>] = 'a^', level: ~edea.kicad.cli_types.Severity = 'warning')

Check design and electrical rules for kicad project.

edea check example                    # checks design and electrical rules
edea check example --no-drc           # checks design rules
edea check example --no-erc           # checks electrical rules
edea check example/example.kicad_pro  # checks design and electrical rules
edea check example/example.kicad_sch  # checks electrical rules
edea check example/example.kicad_pcb  # checks design rules

edea.cli.version()

Print the version of edea.

edea version

sub-command for adding edea modules or rules to a project

edea.cli.add.module(local_path: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7f7a3a3a7b10>] = None, git_url: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f7a3a3a5150>] = None, edea_url: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f7a3a3a7fd0>] = None, path: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7f7a3a3a7e50>] = None, target: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7f7a3a3a7bd0>] = None)

Add an edea module to your current project.

edea add module --local-dir ../example/
edea add module --git-url https://gitlab.com/edea-dev/test-modules --path 3v3ldo
edea add module --edea-url https://edea.com/api/v1/module/79248d65-45a3-4ef3-a7c6-85961d335baa

edea.cli.add.rules(local_path: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7f7a3a3a74d0>] = None, git_url: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f7a3a3a7810>] = None, edea_url: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7f7a3a3a6910>] = None, path: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7f7a3a3a7910>] = None)

Add edea rules to your current project.

edea add rules

Module metadata

CHANGELOG