Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leoheck/kiri-docker
Kiri Docker project to run Kiri Revision Inspector inside a Docker container
https://github.com/leoheck/kiri-docker
container docker kicad kiri
Last synced: about 1 month ago
JSON representation
Kiri Docker project to run Kiri Revision Inspector inside a Docker container
- Host: GitHub
- URL: https://github.com/leoheck/kiri-docker
- Owner: leoheck
- Created: 2022-12-09T23:43:00.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-02T15:35:14.000Z (7 months ago)
- Last Synced: 2024-06-02T17:25:18.504Z (7 months ago)
- Topics: container, docker, kicad, kiri
- Language: Shell
- Homepage:
- Size: 41 KB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kiri Docker
Kiri Docker is a convenient and easy way to run [Kiri](https://github.com/leoheck/kiri) pre-installed in a Ubuntu container.
> Kiri repo is not necessary to run Kiri Docker
Kiri 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.
The existing kiri-docker image is hosted in Docker Hub here https://hub.docker.com/r/leoheck/kiri/tags
# Getting the existing docker image
The docker container can be donwloaded through this repo with:
```bash
gh repo clone leoheck/kiri-docker
make docker_pull
```
Alternatively, you can pull the latest image file with:
```bash
docker pull leoheck/kiri:latest
```
# Building your own docker image
It is also possible to build the docker image yourself, if needed:
```bash
gh repo clone leoheck/kiri-docker
cd kiri-docker
make docker_build
```
# Environment
Download or build the docker image and then set your PATH to this repo with:
```bash
export PATH="$(pwd)/kiri-docker/"
```
# Using Kiri Docker
To run kiri on the given Kicad project repository:
```bash
kiri-docker [OPTIONS] [REPO_PATH] [-k|--kiri [ARGS]
```
For extended arguments list, please use the flag `-h`.
# Examples
Just launch the container for manual exploration
```bash
kiri-docker
```
This example launches kiri-docker, passing the path of the project path and a parameter `-r` of kiri to remove old files.
```bash
kiri-docker "/home/lheck/Documents/assoc-board" -k -r
```
This, starts the container with the project folder and do nothing, so you can debug something manually.
```bash
kiri-docker "/home/lheck/Documents/assoc-board" -d
```
Launch kiri with a repo that has a nested kicad project (kicad project is not in the root path)
```bash
kiri-docker "/home/lheck/Documents/assoc-board" -k "nested_project/board.kicad_pro"
```
Starts docker binding project's repo, do not run kiri, and run pcbdraw command:
This example uses the image generated with `Dockerfile_kicad-auto`.
```bash
kiri-docker "/home/lheck/Documents/assoc-board" -i leoheck/kiri:test -d -c "pcbdraw board.kicad_pcb board.svg"
```