Command line tool
edea command line tool
- edea.cli.check(project_or_file: ~pathlib.Annotated[~pathlib.Path, <typer.models.ArgumentInfo object at 0x7b388a109190>], custom_dr: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7b388a109650>] = None, custom_dr_url: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7b388a109490>] = None, drc: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7b388a109350>] = True, erc: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7b388a109250>] = True, ignore_regex: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7b388a109510>] = '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
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 0x7b388a1c9290>] = None, git_url: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7b388a1c9310>] = None, edea_url: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7b388a1c9250>] = None, path: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7b388a1c9090>] = None, target: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7b388a1c9210>] = 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 0x7b388a1c9450>] = None, git_url: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7b388a1ca050>] = None, edea_url: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7b388a1c97d0>] = None, path: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7b388a1c9810>] = None)
Add edea rules to your current project.
edea add rules