Skip to content

Commit 15d1b1f

Browse files
gary149Wauplinhanouticelina
authored
Replace pkgx install instruction with uv (#3420)
* docs(cli): replace pkgx install instructions with uv (uv tool + uvx) * docs(ko): replace pkgx install instructions with uv (uv tool + uvx) * Update docs/source/en/guides/cli.md Co-authored-by: célina <hanouticelina@gmail.com> * Update docs/source/en/guides/cli.md --------- Co-authored-by: Lucain <lucain@huggingface.co> Co-authored-by: célina <hanouticelina@gmail.com>
1 parent ff79763 commit 15d1b1f

File tree

2 files changed

+25
-13
lines changed

2 files changed

+25
-13
lines changed

docs/source/en/guides/cli.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,30 @@ If the CLI is correctly installed, you should see a list of all the options avai
4646
> [!TIP]
4747
> The `--help` option is very convenient for getting more details about a command. You can use it anytime to list all available options and their details. For example, `hf upload --help` provides more information on how to upload files using the CLI.
4848
49-
### Alternative install
49+
### Other installation methods
5050

51-
#### Using pkgx
51+
#### Using uv
5252

53-
[Pkgx](https://pkgx.sh) is a blazingly fast cross platform package manager that runs anything. You can install huggingface-cli using pkgx as follows:
53+
You can install and run the `hf` CLI with [uv](https://docs.astral.sh/uv/).
54+
55+
Make sure uv is installed (adds `uv` and `uvx` to your PATH):
5456

5557
```bash
56-
>>> pkgx install huggingface-cli
58+
>>> curl -LsSf https://astral.sh/uv/install.sh | sh
5759
```
5860

59-
Or you can run huggingface-cli directly:
61+
Then install the CLI globally and use it anywhere:
6062

6163
```bash
62-
>>> pkgx huggingface-cli --help
64+
>>> uv tool install "huggingface_hub[cli]"
65+
>>> hf auth whoami
6366
```
6467

65-
Check out the pkgx huggingface page [here](https://pkgx.dev/pkgs/huggingface.co/) for more details.
68+
Alternatively, run the CLI ephemerally with `uvx` (no global install):
69+
70+
```bash
71+
>>> uvx --from huggingface_hub hf auth whoami
72+
```
6673

6774
#### Using Homebrew
6875

docs/source/ko/guides/cli.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,21 +48,26 @@ CLI가 제대로 설치되었다면 CLI에서 사용 가능한 모든 옵션 목
4848
4949
### 다른 방법으로 설치하기 [[alternative-install]]
5050

51-
#### pkgx 사용하기 [[using-pkgx]]
51+
#### uv 사용하기 [[using-uv]]
5252

53-
[Pkgx](https://pkgx.sh)는 다양한 플랫폼에서 빠르게 작동하는 패키지 매니저입니다. 다음과 같이 pkgx를 사용하여 huggingface-cli를 설치할 수 있습니다:
53+
[uv](https://docs.astral.sh/uv/)를 사용하면 `hf` CLI를 설치하거나, 설치 없이 바로 실행할 수 있습니다. 먼저 uv를 설치하세요 (PATH에 `uv``uvx`가 추가됩니다):
5454

5555
```bash
56-
>>> pkgx install huggingface-cli
56+
>>> curl -LsSf https://astral.sh/uv/install.sh | sh
5757
```
5858

59-
또는 pkgx를 통해 huggingface-cli를 직접 실행할 수도 있습니다:
59+
영구적으로 도구를 설치해 어디에서나 사용하려면:
6060

6161
```bash
62-
>>> pkgx huggingface-cli --help
62+
>>> uv tool install "huggingface_hub[cli]"
63+
>>> hf --help
6364
```
6465

65-
pkgx huggingface에 대한 자세한 내용은 [여기](https://pkgx.dev/pkgs/huggingface.co/)에서 확인할 수 있습니다.
66+
전역 설치 없이 일회성으로 실행하려면 `uvx`를 사용하세요:
67+
68+
```bash
69+
>>> uvx --from huggingface_hub hf --help
70+
```
6671

6772
#### Homebrew 사용하기 [[using-homebrew]]
6873

0 commit comments

Comments
 (0)