{"id":19734722,"url":"https://github.com/leoheck/kiri-docker","last_synced_at":"2025-04-30T04:31:06.002Z","repository":{"id":64635945,"uuid":"576463671","full_name":"leoheck/kiri-docker","owner":"leoheck","description":"Kiri Docker project to run Kiri Revision Inspector inside a Docker container","archived":false,"fork":false,"pushed_at":"2024-06-02T15:35:14.000Z","size":42,"stargazers_count":5,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-06-02T17:25:18.504Z","etag":null,"topics":["container","docker","kicad","kiri"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leoheck.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-09T23:43:00.000Z","updated_at":"2024-06-02T15:35:17.000Z","dependencies_parsed_at":"2024-04-09T20:24:06.270Z","dependency_job_id":"bd6118cd-fe5a-40dc-9ed4-92e0efcb4a50","html_url":"https://github.com/leoheck/kiri-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leoheck%2Fkiri-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leoheck%2Fkiri-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leoheck%2Fkiri-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leoheck%2Fkiri-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leoheck","download_url":"https://codeload.github.com/leoheck/kiri-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224198014,"owners_count":17271999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["container","docker","kicad","kiri"],"created_at":"2024-11-12T00:39:22.808Z","updated_at":"2025-04-30T04:31:05.996Z","avatar_url":"https://github.com/leoheck.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Kiri Docker\n\nKiri Docker is a convenient and easy way to run [Kiri](https://github.com/leoheck/kiri) pre-installed in a Ubuntu container.\n\n\u003e Kiri repo is not necessary to run Kiri Docker\n\nKiri Docker works by mounting the user's project from the host machine inside the container. This way, the output files are easily accessible from the host system making it simple to visualize using the host's browser.\n\nThe existing kiri-docker image is hosted in Docker Hub here https://hub.docker.com/r/leoheck/kiri/tags\n\n# Getting the existing docker image\n\nThe docker container can be donwloaded through this repo with:\n\n```bash\ngh repo clone leoheck/kiri-docker\nmake docker_pull\n```\n\nAlternatively, you can pull the latest image file with:\n```bash\ndocker pull leoheck/kiri:latest\n```\n\n# Building your own docker image\n\nIt is also possible to build the docker image yourself, if needed:\n\n```bash\ngh repo clone leoheck/kiri-docker\ncd kiri-docker\nmake docker_build\n```\n\n# Environment\n\nSet your PATH to this repo with:\n\n```bash\nexport PATH=\"${PATH}:$(pwd)/kiri-docker/\"\n```\n\n# Using Kiri Docker\n\nTo run kiri on the given Kicad project repository:\n\n```bash\nkiri-docker [OPTIONS] [REPO_PATH] [-k|--kiri [ARGS]\n```\n\nFor extended arguments list, please use the flag `-h`.\n\n# Examples\n\nJust launch the container for manual exploration\n\n```bash\nkiri-docker\n```\n\nThis example launches kiri-docker, passing the path of the project path and a parameter `-r` of kiri to remove old files.\n\n```bash\nkiri-docker \"/home/lheck/Documents/assoc-board\" -k -r\n```\n\nThis, starts the container with the project folder and do nothing, so you can debug something manually.\n\n```bash\nkiri-docker \"/home/lheck/Documents/assoc-board\" -d\n```\n\nLaunch kiri with a repo that has a nested kicad project (kicad project is not in the root path)\n\n```bash\nkiri-docker \"/home/lheck/Documents/assoc-board\" -k \"nested_project/board.kicad_pro\"\n```\n\nStarts docker binding project's repo, do not run kiri, and run pcbdraw command:\nThis example uses the image generated with `Dockerfile_kicad-auto`.\n\n```bash\nkiri-docker \"/home/lheck/Documents/assoc-board\" -i leoheck/kiri:test -d -c \"pcbdraw board.kicad_pcb board.svg\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleoheck%2Fkiri-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleoheck%2Fkiri-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleoheck%2Fkiri-docker/lists"}