Skip to content

docs: document Windows and LiteLLM provider setup#334

Open
KairosMarco wants to merge 2 commits into
VectifyAI:mainfrom
KairosMarco:docs/windows-provider-quickstart
Open

docs: document Windows and LiteLLM provider setup#334
KairosMarco wants to merge 2 commits into
VectifyAI:mainfrom
KairosMarco:docs/windows-provider-quickstart

Conversation

@KairosMarco

@KairosMarco KairosMarco commented Jun 22, 2026

Copy link
Copy Markdown

Summary

This PR adds a small quickstart clarification for local PageIndex setup:

  • recommend a Python virtual environment before installing dependencies,
  • add Windows PowerShell activation commands,
  • document the common Activate.ps1 execution-policy workaround using only the current shell session,
  • show how to use a non-OpenAI LiteLLM provider by setting the provider key and passing --model.

Why

New users can currently follow the README successfully on Unix-like shells, but Windows users may hit PowerShell's script execution policy when activating .venv.

The README also mentions multi-LLM support through LiteLLM, but the quickstart only shows OPENAI_API_KEY. Adding a provider-key example makes it clearer that users can run PageIndex with other LiteLLM-supported providers without changing code.

Changes

  • Extend the install step with python3 -m venv .venv and activation.
  • Add equivalent Windows PowerShell commands.
  • Add Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass as a current-session workaround for blocked virtualenv activation.
  • Add a non-OpenAI provider example using DASHSCOPE_API_KEY and --model dashscope/qwen-plus.
  • Point users back to LiteLLM provider docs for exact model prefixes and environment variables.

Validation

git diff --check

Local result:

No whitespace errors.

@KairosMarco KairosMarco changed the title Document Windows and LiteLLM provider setup docs: document Windows and LiteLLM provider setup Jun 22, 2026
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.

1 participant