fix readme github images

This commit is contained in:
Nicolò Boschi 2025-12-04 10:09:55 +01:00
parent 1c5981b1f2
commit 4b8fccb5e8
4 changed files with 59 additions and 18 deletions

View file

@ -254,10 +254,41 @@ jobs:
id: get_version id: get_version
run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
- name: Download all artifacts - name: Download Python packages
uses: actions/download-artifact@v4 uses: actions/download-artifact@v4
with: with:
path: ./artifacts name: python-packages
path: ./artifacts/python-packages
- name: Download TypeScript client
uses: actions/download-artifact@v4
with:
name: typescript-client
path: ./artifacts/typescript-client
- name: Download Rust CLI (Linux)
uses: actions/download-artifact@v4
with:
name: rust-cli-hindsight-linux-amd64
path: ./artifacts/rust-cli-linux
- name: Download Rust CLI (macOS Intel)
uses: actions/download-artifact@v4
with:
name: rust-cli-hindsight-darwin-amd64
path: ./artifacts/rust-cli-darwin-amd64
- name: Download Rust CLI (macOS ARM)
uses: actions/download-artifact@v4
with:
name: rust-cli-hindsight-darwin-arm64
path: ./artifacts/rust-cli-darwin-arm64
- name: Download Helm chart
uses: actions/download-artifact@v4
with:
name: helm-chart
path: ./artifacts/helm-chart
- name: Prepare release assets - name: Prepare release assets
run: | run: |
@ -269,9 +300,9 @@ jobs:
# TypeScript client # TypeScript client
cp artifacts/typescript-client/*.tgz release-assets/ || true cp artifacts/typescript-client/*.tgz release-assets/ || true
# Rust CLI binaries # Rust CLI binaries
cp artifacts/rust-cli-hindsight-linux-amd64/hindsight-linux-amd64 release-assets/ || true cp artifacts/rust-cli-linux/hindsight-linux-amd64 release-assets/ || true
cp artifacts/rust-cli-hindsight-darwin-amd64/hindsight-darwin-amd64 release-assets/ || true cp artifacts/rust-cli-darwin-amd64/hindsight-darwin-amd64 release-assets/ || true
cp artifacts/rust-cli-hindsight-darwin-arm64/hindsight-darwin-arm64 release-assets/ || true cp artifacts/rust-cli-darwin-arm64/hindsight-darwin-arm64 release-assets/ || true
# Helm chart # Helm chart
cp artifacts/helm-chart/*.tgz release-assets/ || true cp artifacts/helm-chart/*.tgz release-assets/ || true
ls -la release-assets/ ls -la release-assets/

View file

@ -28,7 +28,7 @@ docker run -p 8888:8888 -p 9999:9999 \
-e HINDSIGHT_API_LLM_PROVIDER=openai \ -e HINDSIGHT_API_LLM_PROVIDER=openai \
-e HINDSIGHT_API_LLM_API_KEY=$OPENAI_API_KEY \ -e HINDSIGHT_API_LLM_API_KEY=$OPENAI_API_KEY \
-e HINDSIGHT_API_LLM_MODEL=gpt-4o-mini \ -e HINDSIGHT_API_LLM_MODEL=gpt-4o-mini \
vectorize/hindsight ghcr.io/vectorize-io/hindsight
``` ```
- **API**: http://localhost:8888 - **API**: http://localhost:8888

View file

@ -27,7 +27,24 @@ You need an LLM API key for fact extraction, entity resolution, and answer gener
**Best for**: Quick start, development, small deployments **Best for**: Quick start, development, small deployments
Docker Compose bundles all dependencies (PostgreSQL with pgvector, API server, Control Plane) in a single command. ### Single Container (Quickest)
Run everything in one container with embedded PostgreSQL:
```bash
docker run -p 8888:8888 -p 9999:9999 \
-e HINDSIGHT_API_LLM_PROVIDER=openai \
-e HINDSIGHT_API_LLM_API_KEY=sk-xxxxxxxxxxxx \
-e HINDSIGHT_API_LLM_MODEL=gpt-4o-mini \
ghcr.io/vectorize-io/hindsight
```
- **API Server**: http://localhost:8888
- **Control Plane** (Web UI): http://localhost:9999
### Docker Compose
For more control, use Docker Compose which bundles all dependencies separately:
```bash ```bash
# Clone the repository # Clone the repository
@ -36,20 +53,13 @@ cd hindsight
# Create environment file # Create environment file
cp .env.example .env cp .env.example .env
# Edit .env with your LLM API key: # Edit .env with your LLM API key
# HINDSIGHT_API_LLM_PROVIDER=groq
# HINDSIGHT_API_LLM_API_KEY=gsk_xxxxxxxxxxxx
# Start all services # Start all services
cd docker cd docker
./start.sh ./start.sh
``` ```
**Services started**:
- **API Server**: http://localhost:8888
- **Control Plane** (Web UI): http://localhost:3000
- **Swagger UI**: http://localhost:8888/docs
**Management**: **Management**:
```bash ```bash
./stop.sh # Stop services ./stop.sh # Stop services

View file

@ -1141,7 +1141,7 @@ provides-extras = ["test"]
[[package]] [[package]]
name = "hindsight-api" name = "hindsight-api"
version = "0.0.14" version = "0.0.15"
source = { editable = "hindsight-api" } source = { editable = "hindsight-api" }
dependencies = [ dependencies = [
{ name = "alembic" }, { name = "alembic" },
@ -1243,7 +1243,7 @@ dev = [
[[package]] [[package]]
name = "hindsight-client" name = "hindsight-client"
version = "0.0.14" version = "0.0.15"
source = { editable = "hindsight-clients/python" } source = { editable = "hindsight-clients/python" }
dependencies = [ dependencies = [
{ name = "aiohttp" }, { name = "aiohttp" },
@ -1275,7 +1275,7 @@ provides-extras = ["test"]
[[package]] [[package]]
name = "hindsight-dev" name = "hindsight-dev"
version = "0.0.14" version = "0.0.15"
source = { editable = "hindsight-dev" } source = { editable = "hindsight-dev" }
dependencies = [ dependencies = [
{ name = "hindsight-api" }, { name = "hindsight-api" },