Command line tool

edea command line tool

edea.cli.check(project_or_file: Path, custom_dr: Path | None = None, custom_dr_url: str | None = None, drc: bool = True, erc: bool = True, ignore_regex: str = 'a^', level: 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: Path | None = None, git_url: str | None = None, edea_url: str | None = None, path: Path | None = None, target: Path | None = 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: Path | None = None, git_url: str | None = None, edea_url: str | None = None, path: Path | None = None)

Add edea rules to your current project.

edea add rules