docs: update installer pages for frictionless uv/pipx/venv install#827
Conversation
…ixes #824) - Major rewrite of docs/install/installer.mdx: three-backend flow (uv tool → pipx → venv fallback), all new CLI flags (--backend, --install-dir, --no-modify-path), all new env vars, shell completions section, updated uninstall/troubleshooting, power-user alternatives - Update docs/install/quickstart.mdx: adds uvx and pipx tabs as first-class install options, new env vars table, updated What Gets Installed table including ~/.local/bin shim - Update docs/installation.mdx: isolation note + link to backends page - Update docs/index.mdx: isolation copy under macOS/Linux tab + uvx/pipx tabs - Update docs/developers/scripts.mdx: new description, features list, env vars, and examples reflecting multi-backend installer - New docs/install/isolation-backends.mdx: decision diagram, side-by-side comparison table, per-backend install examples, PATH management section - Update docs.json: add Install group with quickstart, installer, and isolation-backends pages Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
|
Warning Review limit reached
More reviews will be available in 51 minutes and 23 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (7)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the PraisonAI documentation to detail the new isolated installation process using three backends (uv tool, pipx, and a venv fallback), including PATH management, shell completions, and uninstallation steps. The reviewer feedback points out a Mermaid diagram syntax issue with escaped brackets in installer.mdx, an incorrect relative symlink path in isolation-backends.mdx, and missing environment variables (PRAISONAI_PYTHON and PRAISONAI_NO_PROMPT) in the tables of scripts.mdx and quickstart.mdx that should be added for consistency.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| B -->|uv found| C[uv tool install praisonai\[all\]]:::tool | ||
| B -->|pipx found| D[pipx install praisonai\[all\]]:::tool | ||
| B -->|neither| E[Create venv at ~/.praisonai/venv]:::tool | ||
| E --> F[pip install praisonai\[all\]]:::tool |
There was a problem hiding this comment.
In Mermaid diagrams, square brackets [ and ] are special characters used to define node shapes. Escaping them with backslashes (e.g., \\[ and \\]) can cause rendering issues or display literal backslashes depending on the Markdown/Mermaid parser. Wrapping the node text in double quotes is the standard and robust way to include square brackets.
B -->|uv found| C["uv tool install praisonai[all]"]:::tool
B -->|pipx found| D["pipx install praisonai[all]"]:::tool
B -->|neither| E["Create venv at ~/.praisonai/venv"]:::tool
E --> F["pip install praisonai[all]"]:::tool
|
|
||
| ### venv (fallback) | ||
|
|
||
| The installer creates `~/.praisonai/venv` and symlinks `~/.local/bin/praisonai → venv/bin/praisonai`. |
There was a problem hiding this comment.
The symlink target venv/bin/praisonai is relative and would resolve to ~/.local/bin/venv/bin/praisonai (which is incorrect and broken). It should point to the absolute path ~/.praisonai/venv/bin/praisonai to match the description in docs/install/installer.mdx.
| | Variable | Default | Description | | ||
| |----------|---------|-------------| | ||
| | `PRAISONAI_VERSION` | `latest` | Specific version to install | | ||
| | `PRAISONAI_EXTRAS` | `""` | Comma-separated extras (ui,chat,api) | | ||
| | `PRAISONAI_SKIP_VENV` | `0` | Skip virtual environment | | ||
| | `PRAISONAI_EXTRAS` | `""` | Comma-separated extras (defaults to `all`) | | ||
| | `PRAISONAI_BACKEND` | `auto` | Force backend: `uv` / `pipx` / `venv` / `system` / `auto` | | ||
| | `PRAISONAI_INSTALL_DIR` | `~/.praisonai` | Base dir for the venv fallback | | ||
| | `PRAISONAI_NO_MODIFY_PATH` | `0` | Skip shell rc PATH modification (`1` to enable) | | ||
| | `PRAISONAI_SKIP_VENV` | `0` | Skip isolation entirely (`1` to enable) | | ||
| | `PRAISONAI_DRY_RUN` | `0` | Preview mode | | ||
| | `PRAISONAI_NO_ONBOARD` | `0` | Skip interactive onboarding entirely | |
There was a problem hiding this comment.
To maintain consistency across all documentation pages, please include PRAISONAI_PYTHON and PRAISONAI_NO_PROMPT in the environment variables table, as they are documented in docs/install/installer.mdx.
| | Variable | Default | Description | | ||
| |----------|---------|-------------| | ||
| | `PRAISONAI_VERSION` | `latest` | Version to install | | ||
| | `PRAISONAI_EXTRAS` | `""` | Comma-separated extras (defaults to `all`) | | ||
| | `PRAISONAI_BACKEND` | `auto` | Force backend: `uv` / `pipx` / `venv` / `system` / `auto` | | ||
| | `PRAISONAI_INSTALL_DIR` | `~/.praisonai` | Base dir for the venv fallback | | ||
| | `PRAISONAI_NO_MODIFY_PATH` | `0` | Skip shell rc PATH modification (`1` to enable) | | ||
| | `PRAISONAI_SKIP_VENV` | `0` | Skip isolation entirely (`1` to enable) | | ||
| | `PRAISONAI_PYTHON` | auto-detect | Python executable path | | ||
| | `PRAISONAI_DRY_RUN` | `0` | Preview mode (`1` to enable) | | ||
| | `PRAISONAI_NO_ONBOARD` | `0` | Skip onboarding (`1` to enable) | |
There was a problem hiding this comment.
To maintain consistency across all documentation pages, please include PRAISONAI_NO_PROMPT in the environment variables table, as it is documented in docs/install/installer.mdx.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
1 participant
Summary
docs/install/installer.mdx: documents all three isolation backends (uv tool → pipx → venv fallback), all new CLI flags (--backend,--install-dir,--no-modify-path), all new env vars, shell completions section,~/.local/bin/praisonaishim, sequence diagram, power-user alternatives, updated uninstall/troubleshootingdocs/install/quickstart.mdx: addsuvxandpipx installas first-class tabs, new flags/env var accordions, updated What Gets Installed tabledocs/installation.mdx: isolation note + link to new backends pagedocs/index.mdx: isolation copy under macOS/Linux tab + uvx/pipx install tabsdocs/developers/scripts.mdx: new description, features list, env vars, and examples for multi-backend installerdocs/install/isolation-backends.mdx: backend decision diagram, side-by-side comparison table (uv / pipx / venv / --no-venv), per-backend install examples, PATH block docsdocs.json: added Install group (quickstart, installer, isolation-backends)Fixes #824
Generated with Claude Code