Update README.md
Browse files
README.md
CHANGED
|
@@ -1,10 +1,67 @@
|
|
| 1 |
---
|
| 2 |
title: README
|
| 3 |
-
emoji:
|
| 4 |
colorFrom: gray
|
| 5 |
colorTo: purple
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
title: README
|
| 3 |
+
emoji: 🐸
|
| 4 |
colorFrom: gray
|
| 5 |
colorTo: purple
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
+
# Toad HF Inference Explorers
|
| 11 |
+
|
| 12 |
+
Explore the best open models with [Toad](https://github.com/batrachianai/toad) and
|
| 13 |
+
[Hugging Face Inference Providers](https://huggingface.co/docs/inference-providers)!
|
| 14 |
+
|
| 15 |
+
**Join this org to get $10 free Inference Provider credits!**
|
| 16 |
+
|
| 17 |
+
## What is Toad?
|
| 18 |
+
|
| 19 |
+
Toad is a terminal-based interface for AI agents from [Will McGugan](https://github.com/willmcgugan),
|
| 20 |
+
creator of Rich and Textual. It connects to AI models via the Agent Client Protocol (ACP).
|
| 21 |
+
|
| 22 |
+
## Quick Start
|
| 23 |
+
|
| 24 |
+
### 1. Install Toad
|
| 25 |
+
|
| 26 |
+
```bash
|
| 27 |
+
curl -fsSL batrachian.ai/install | sh
|
| 28 |
+
```
|
| 29 |
+
|
| 30 |
+
Or for Python developers:
|
| 31 |
+
|
| 32 |
+
```bash
|
| 33 |
+
uv tool install -U batrachian-toad
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
### 2. Authenticate with Hugging Face
|
| 37 |
+
|
| 38 |
+
```bash
|
| 39 |
+
hf auth login
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
Or set your `HF_TOKEN` environment variable.
|
| 43 |
+
|
| 44 |
+
### 3. Launch Toad
|
| 45 |
+
|
| 46 |
+
```bash
|
| 47 |
+
toad
|
| 48 |
+
```
|
| 49 |
+
|
| 50 |
+
Select **"Hugging Face Inference Providers"** from the agent store.
|
| 51 |
+
|
| 52 |
+
### 4. Switch models
|
| 53 |
+
|
| 54 |
+
Use `/set-model` in the chat to change the active model for your session.
|
| 55 |
+
|
| 56 |
+
## Your Free Credits
|
| 57 |
+
|
| 58 |
+
As a member of this org, you receive **$10 in free Inference Provider credits**.
|
| 59 |
+
Use them to explore hundreds of open models from dozens of providers!
|
| 60 |
+
|
| 61 |
+
**Note:** To receive credits, you'll need to add a payment method to your [Hugging Face billing settings](https://huggingface.co/settings/billing). This is for account verification only - you won't be charged unless you exceed your free credits.
|
| 62 |
+
|
| 63 |
+
## Resources
|
| 64 |
+
|
| 65 |
+
- [Toad on GitHub](https://github.com/batrachianai/toad)
|
| 66 |
+
- [Inference Providers Docs](https://huggingface.co/docs/inference-providers)
|
| 67 |
+
- [Available Models](https://huggingface.co/models?inference_provider=all)
|