Skip to content

doc(install): fast track installation (without clone)#15

Open
samber wants to merge 1 commit intohcompai:mainfrom
samber:doc/getting-start-fast-track
Open

doc(install): fast track installation (without clone)#15
samber wants to merge 1 commit intohcompai:mainfrom
samber:doc/getting-start-fast-track

Conversation

@samber
Copy link

@samber samber commented Mar 9, 2026

It took me 15min to understand how to start the project and fix its dependencies. I think it should take < 2min.

This PR adds 2 simple commands to install and run the project without cloning the repository.

I would suggest adding a Docker image as well.

Making the distribution easy will help you gain traction.

Requires #13 to be merged first

Copilot AI review requested due to automatic review settings March 9, 2026 16:58
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the project’s installation documentation to enable a faster “no clone” setup path, aiming to reduce time-to-first-run for new users.

Changes:

  • Add a pipx install git+... quick-start install path.
  • Add an example command to run surfer-h-cli using environment variables.
  • Minor README formatting cleanup (removal of extra blank lines).
Comments suppressed due to low confidence (1)

README.md:63

  • The new Quick Start section is immediately followed by ### From sources, but that section starts with cp .env.example .env without first telling the reader to clone the repository / change into the repo directory. Adding an explicit git clone ... && cd ... (and any needed dependency bootstrap like uv sync) at the start of the "From sources" section would make the flow unambiguous.
### From sources

Next, copy the example env variables.

```bash
cp .env.example .env
</details>



---

💡 <a href="/hcompai/surfer-h-cli/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.

Comment on lines +32 to +35
Next, install the project.

```bash
pipx install git+https://github.com/hcompai/surfer-h-cli
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

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

The Quick Start installs via pipx, but the repo requires Python >=3.11 (see pyproject.toml) and pipx may default to an older system Python. Consider adding a short prereq note and/or showing pipx install --python python3.11 ... (and optionally pipx ensurepath) so the install works reliably.

Suggested change
Next, install the project.
```bash
pipx install git+https://github.com/hcompai/surfer-h-cli
Prerequisite: make sure you have **Python 3.11 or newer** and `pipx` installed.
Next, install the project.
```bash
pipx install --python python3.11 git+https://github.com/hcompai/surfer-h-cli

Copilot uses AI. Check for mistakes.
Next, install the project.

```bash
pipx install git+https://github.com/hcompai/surfer-h-cli
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

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

The install URL here points to https://github.com/hcompai/surfer-h-cli, but the package metadata in pyproject.toml advertises https://github.com/hcompai/open-surferh as the Repository/Homepage. This mismatch is likely to confuse users (or install the wrong code). Please align the README install command with the canonical repo URL used by the project metadata.

Suggested change
pipx install git+https://github.com/hcompai/surfer-h-cli
pipx install git+https://github.com/hcompai/open-surferh

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants