@@ -26,13 +26,25 @@ The up-to-date version of the artifact can be found on github ([Link-Anchor gith
2626
2727# ⚙️ Installation
2828
29+ ## Docker
30+ You can pull the prebuild docker image:
31+ ``` bash
32+ docker pull ghcr.io/ise-research/linkanchor
33+ ```
34+ or to build it manually:
35+ ``` bash
36+ docker build . --tag ghcr.io/ise-research/linkanchor
37+ ```
38+
39+ ## From Srouce
40+
2941> Estimated setup time: < 10 minutes.
3042
31- ## Prerequisites
43+ ### Prerequisites
3244- Rust: Required for the git and code wrapper modules.
3345- Python 3.10+: Recommended environment.
3446
35- ## Installation Steps
47+ ### Installation Steps
3648
3749``` bash
3850
@@ -59,27 +71,37 @@ pip install .
5971Use the following command to find the commit hash of the resolving commit:
6072
6173``` bash
62-
63- export OPENAI_API_KEY=< YOUR_API_KEY>
74+ # If using the docker image
75+ docker run -it \
76+ -e OPENAI_API_KEY=< YOUR_API_KEY> \
77+ ghcr.io/ise-research/linkanchor \
78+ --git https://github.com/pallets/flask --issue https://github.com/pallets/flask/issues/5472
6479
6580# If using raw python3
81+ export OPENAI_API_KEY=< YOUR_API_KEY>
6682python3 -m src.main --git https://github.com/pallets/flask --issue https://github.com/pallets/flask/issues/5472
6783
6884# if using uv (Recommanded)
85+ export OPENAI_API_KEY=< YOUR_API_KEY>
6986uv run -m src.main --git https://github.com/pallets/flask --issue https://github.com/pallets/flask/issues/5472
7087```
7188
7289using the ` --explain ` flag, you can enter interactive mode in which LinkAnchor will explain the decision making process behind each step of the process.
7390
7491``` bash
75- export OPENAI_API_KEY=< YOUR_API_KEY>
92+ # If using the docker image
93+ docker run -it \
94+ -e OPENAI_API_KEY=< YOUR_API_KEY> \
95+ ghcr.io/ise-research/linkanchor \
96+ --git https://github.com/pallets/flask --issue https://github.com/pallets/flask/issues/5472 --explain
7697
7798# If using raw python3
99+ export OPENAI_API_KEY=< YOUR_API_KEY>
78100python3 -m src.main --git https://github.com/pallets/flask --issue https://github.com/pallets/flask/issues/5472 --explain
79101
80102# if using uv (Recommanded)
103+ export OPENAI_API_KEY=< YOUR_API_KEY>
81104uv run -m src.main --git https://github.com/pallets/flask --issue https://github.com/pallets/flask/issues/5472 --explain
82-
83105```
84106
85107
0 commit comments