Skip to content

Commit 80e3e55

Browse files
committed
docs: Update README with package installation and CLI usage instructions
1 parent b95c5f2 commit 80e3e55

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,28 @@ AutoSQL은 자연어 입력을 기반으로 SQL을 생성하는 프로젝트입
2424
pip install -r requirements.txt
2525
```
2626

27+
### 2️⃣ 패키지 설치
28+
29+
`setup.py`를 통해 패키지를 설치할 수 있습니다:
30+
31+
```bash
32+
python setup.py install
33+
```
34+
35+
### 3️⃣ CLI 명령어 사용
36+
37+
설치 후, `autosql` 명령어를 사용할 수 있습니다. 예를 들어, Streamlit 앱을 실행하려면 다음과 같이 입력합니다:
38+
39+
```bash
40+
autosql --run-streamlit
41+
```
42+
43+
기본 포트는 8501이며, 다른 포트를 사용하려면 `-p` 옵션을 사용하세요:
44+
45+
```bash
46+
autosql --run-streamlit -p 8502
47+
```
48+
2749
### 4️⃣ 환경 변수 설정
2850

2951
다음 환경 변수들은 설정되어야 합니다. `.env` 파일을 생성하여 다음과 같이 관리할 수 있습니다:

0 commit comments

Comments
 (0)