Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.git/
.github/
# configs/
# images/
# scripts/
# stubs/
# vscode-extension/
.gitignore
# CITATION.cff
# README.md
# logo.png
# poetry.lock
.dockerignore

15 changes: 15 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
FROM python:3.14-slim-trixie

COPY . /usr/src/glitch
WORKDIR /usr/src/glitch
RUN \
apt-get update \
&& apt-get install -y --no-install-recommends ruby \
&& apt-get clean \
&& rm -rf /var/lib/apt/lists/*

RUN python -m pip install --no-cache-dir -e .

WORKDIR /glitch

ENTRYPOINT ["glitch"]
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@ is installed via Poetry. Since Poetry uses virtual environments it does not
create a binary for GLITCH available in the user's PATH, which is required for
the VSCode extension._

### Docker

You can build a docker image running:
```bash
docker build -t glitch .
```
Please read `usage` > `Docker`

## Usage

To explore all available options, use the command:
Expand Down Expand Up @@ -90,6 +98,18 @@ poetry shell
glitch --help
```

### Docker
Please read `install` > `docker` first

Use `docker run glitch [OPTIONS] PATH [OUTPUT]`

Examples:

```bash
docker run --rm glitch --help
docker run --rm -v /Users/user/.../project:/glitch:ro glitch --tech terraform .
```

## Tests

To run the tests for GLITCH go to the folder ```glitch``` and run:
Expand Down