Update README.md
Browse files
README.md
CHANGED
|
@@ -9,4 +9,46 @@ license: apache-2.0
|
|
| 9 |
short_description: Auto completion for the `huggingface-cli download` command
|
| 10 |
---
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 9 |
short_description: Auto completion for the `huggingface-cli download` command
|
| 10 |
---
|
| 11 |
|
| 12 |
+
# Hugging Face CLI Autocompletion
|
| 13 |
+
|
| 14 |
+
This repository contains a Bash script to enable autocompletion for the `huggingface-cli` command, specifically for downloading models from the Hugging Face Model Hub.
|
| 15 |
+
|
| 16 |
+
## Features
|
| 17 |
+
|
| 18 |
+
- **Command Suggestions**: Automatically suggests available commands like `download`, `upload`, etc.
|
| 19 |
+
- **Model Name Completion**: When typing `huggingface-cli download`, it fetches and suggests model names from the Hugging Face Model Hub.
|
| 20 |
+
|
| 21 |
+
### Installation
|
| 22 |
+
|
| 23 |
+
To install the autocompletion script, run the following command in your terminal:
|
| 24 |
+
|
| 25 |
+
```bash
|
| 26 |
+
curl -sSL huggingface_autocomplete.sh | bash
|
| 27 |
+
```
|
| 28 |
+
|
| 29 |
+
### Usage
|
| 30 |
+
|
| 31 |
+
After installation, you can use the autocompletion feature as follows:
|
| 32 |
+
|
| 33 |
+
- Start typing the command:
|
| 34 |
+
```bash
|
| 35 |
+
huggingface-cli download google/
|
| 36 |
+
```
|
| 37 |
+
|
| 38 |
+
- Press <TAB> to see suggestions:
|
| 39 |
+
```
|
| 40 |
+
$ huggingface-cli download google/
|
| 41 |
+
google/codegemma-7b google/flan-t5-xl google/gemma-2-2b-jpn-it-flax
|
| 42 |
+
google/madlad400-10b-mt google/vit-base-patch16-224 google/datagemma-rag-27b-it
|
| 43 |
+
google/flan-t5-xxl google/gemma-2-2b-jpn-it-pytorch ...
|
| 44 |
+
```
|
| 45 |
+
|
| 46 |
+
|
| 47 |
+
### Contributing
|
| 48 |
+
|
| 49 |
+
Feel free to contribute by submitting issues or pull requests. Your contributions are welcome!
|
| 50 |
+
|
| 51 |
+
|
| 52 |
+
### License
|
| 53 |
+
|
| 54 |
+
This project is licensed under the MIT License.
|