Skip to content

👷 Adding Dockerfile & Docker usage docs #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kipelovets wants to merge 1 commit into
base: main
Choose a base branch
from
Open

👷 Adding Dockerfile & Docker usage docs #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
FROM python:3.13-alpine

RUN pip install terminalgpt

ENTRYPOINT ["terminalgpt"]
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,22 @@ rm "$package_location"
pipx install terminalgpt==2.2.7 --force
```

### Using Docker

1. Pull the image.

```sh
docker pull adamyodinsky/terminalgpt
```

2. Use the image, mounting the configuration directory as a volume.

```sh
docker run --rm -it -v $HOME/.terminalgpt:/root/.terminalgpt adamyodinsky/terminalgpt terminalgpt install
```

See [Recommended aliases](#recommended-aliases) for shell aliases that make the Docker commands shorter.

### Setup

1. Now you have `terminalgpt` command available in your terminal. Run the following install command to configure the app.
Expand Down Expand Up @@ -168,6 +184,16 @@ echo alias tgpto="terminalgpt one-shot" >> ~/.bashrc
echo alias tgptn="terminalgpt new" >> ~/.bashrc
```

### Docker

Here's an example of Bash aliases for using the Docker image:

```sh
echo alias tgpt="docker run --rm -it -v $HOME/.terminalgpt:/root/.terminalgpt adamyodinsky/terminalgpt" >> ~/.bashrc
echo alias tgpto="docker run --rm -it -v $HOME/.terminalgpt:/root/.terminalgpt adamyodinsky/terminalgpt one-shot" >> ~/.bashrc
echo alias tgptn="docker run --rm -it -v $HOME/.terminalgpt:/root/.terminalgpt adamyodinsky/terminalgpt new" >> ~/.bashrc
```

---

[![Star History Chart](https://api.star-history.com/svg?repos=adamyodinsky/TerminalGPT&type=Date)](https://www.star-history.com/#adamyodinsky/TerminalGPT&Date)
Expand Down