Skip to content
This repository was archived by the owner on Jun 25, 2026. It is now read-only.

Commit caa89fe

Browse files
committed
doc(install): fast track installation (without clone)
1 parent d85bc37 commit caa89fe

1 file changed

Lines changed: 26 additions & 2 deletions

File tree

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,32 @@ The Surfer-H-CLI is the command-line interface for running and controlling the S
2929
To get started, first generate an API key at: https://portal.hcompany.ai.
3030
*This API key will allow you to run inference on H company models. Guide: [generate an API key](https://hub.hcompany.ai/surferh/generateanapikey)*
3131

32+
Next, install the project.
33+
34+
```bash
35+
pipx install git+https://github.com/hcompai/surfer-h-cli
36+
```
37+
38+
And run it:
39+
40+
```bash
41+
export HAI_API_KEY=...
42+
export HAI_MODEL_URL=...
43+
export HAI_MODEL_NAME=...
44+
45+
surfer-h-cli \
46+
--task "Explore H Company's website to discover their recent blog posts." \
47+
--url "https://www.hcompany.ai" \
48+
--max_n_steps 30 \
49+
--base_url_localization "$HAI_MODEL_URL" \
50+
--model_name_localization "$HAI_MODEL_NAME" \
51+
--temperature_localization 0.7 \
52+
--base_url_navigation "$HAI_MODEL_URL" \
53+
--model_name_navigation "$HAI_MODEL_NAME" \
54+
--temperature_navigation 0.0
55+
```
56+
57+
### From sources
3258

3359
Next, copy the example env variables.
3460

@@ -64,8 +90,6 @@ Running with the frontend interface:
6490

6591
This command will automatically start both the Surfer-H backend and the Next.js frontend, making the web interface available at [http://localhost:3000](http://localhost:3000).
6692

67-
68-
6993
# Holo models
7094

7195
[Holo1](https://huggingface.co/collections/Hcompany/holo1-683dd1eece7eb077b96d0cbd) and [Holo1.5](https://huggingface.co/collections/Hcompany/holo15-68c1a5736e8583a309d23d9bd) are Action Vision-Language Models (VLMs) developed by [**H Company**](https://www.hcompany.ai/) for use in Surfer-H. The Holo models enable the agent to understand and act in digital environments. Holo is built based on 3 core components that shape and determine its behaviour: policy, localizer, and validator. These are defined below:

0 commit comments

Comments
 (0)