Skip to content

Replace pkgx install instruction with uv #3420

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

Merged
merged 4 commits into from
Oct 7, 2025
Merged

Replace pkgx install instruction with uv #3420

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c634604
docs(cli): replace pkgx install instructions with uv (uv tool + uvx)
gary149 Oct 7, 2025
724cc82
docs(ko): replace pkgx install instructions with uv (uv tool + uvx)
gary149 Oct 7, 2025
a13d1e0
Update docs/source/en/guides/cli.md
Wauplin Oct 7, 2025
0731f88
Update docs/source/en/guides/cli.md
Wauplin Oct 7, 2025
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
21 changes: 14 additions & 7 deletions docs/source/en/guides/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,23 +46,30 @@ If the CLI is correctly installed, you should see a list of all the options avai
> [!TIP]
> 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.

### Alternative install
### Other installation methods

#### Using pkgx
#### Using uv

[Pkgx](https://pkgx.sh) is a blazingly fast cross platform package manager that runs anything. You can install huggingface-cli using pkgx as follows:
You can install and run the `hf` CLI with [uv](https://docs.astral.sh/uv/).

Make sure uv is installed (adds `uv` and `uvx` to your PATH):

```bash
>>> pkgx install huggingface-cli
>>> curl -LsSf https://astral.sh/uv/install.sh | sh
```

Or you can run huggingface-cli directly:
Then install the CLI as a persistent tool and use it anywhere:

```bash
>>> pkgx huggingface-cli --help
>>> uv tool install "huggingface_hub[cli]"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL 😮

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also a TIL 🤯

>>> hf --help
```

Check out the pkgx huggingface page [here](https://pkgx.dev/pkgs/huggingface.co/) for more details.
Alternatively, run the CLI ephemerally with `uvx` (no global install):

```bash
>>> uvx --from huggingface_hub hf auth whoami
```

#### Using Homebrew

Expand Down
17 changes: 11 additions & 6 deletions docs/source/ko/guides/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,26 @@ CLI가 제대로 설치되었다면 CLI에서 사용 가능한 모든 옵션 목

### 다른 방법으로 설치하기 [[alternative-install]]

#### pkgx 사용하기 [[using-pkgx]]
#### uv 사용하기 [[using-uv]]

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

```bash
>>> pkgx install huggingface-cli
>>> curl -LsSf https://astral.sh/uv/install.sh | sh
```

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

```bash
>>> pkgx huggingface-cli --help
>>> uv tool install "huggingface_hub[cli]"
>>> hf --help
```

pkgx huggingface에 대한 자세한 내용은 [여기](https://pkgx.dev/pkgs/huggingface.co/)에서 확인할 수 있습니다.
전역 설치 없이 일회성으로 실행하려면 `uvx`를 사용하세요:

```bash
>>> uvx --from huggingface_hub hf --help
```

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

Expand Down