feat: one-command installers for macOS, Linux and Windows

deployment/install.sh (curl | bash) and install.ps1 (irm | iex) check for
Docker, install uv when it is missing or older than 0.8 (pinned 0.12.15 via
Astral's installer), install or upgrade the docsgpt package with
`uv tool install`, and hand the terminal to `docsgpt up` with any arguments.
On Linux without Docker the shell installer offers get.docker.com. Both run
entirely inside a function, so a download cut short runs nothing.

Releases attach both scripts next to the Compose file, which is where
docs.ac/install and docs.ac/install.ps1 will point. installer-lint.yml runs
shellcheck and the PowerShell parser; docker-image-verify.yml now installs
through install.sh. README, Quickstart, Docker-Deploying and the changelog
lead with the one-liner.
This commit is contained in:
Alex committed 2026-09-16 01:10:11 +01:00
1 parent 6b6bd1b0fb
commit 4f0bf2cca8
9 files changed
+455 -101

No files matched your search

+12 -2
View File
@@ -20,8 +20,18 @@ Docker is the recommended method for deploying DocsGPT, providing a consistent a
## Run it with `docsgpt up`
The `docsgpt` Python package can set up and run the stack described below for
you. It needs Docker with Compose 2.24 or newer, and Python 3.12 or newer (uv
installs one when it is missing):
you. It needs Docker with Compose 2.24 or newer. The installer gets
[uv](https://docs.astral.sh/uv/), installs the package with it and runs
`docsgpt up`:
```bash
curl -fsSL https://docs.ac/install | bash # macOS and Linux
irm https://docs.ac/install.ps1 | iex # Windows (PowerShell)
```
Both scripts are attached to every [release](https://github.com/arc53/DocsGPT/releases)
as `install.sh` and `install.ps1`. To install the package yourself instead
(Python 3.12 or newer; uv brings one when it is missing):
```bash
uv tool install docsgpt # or: pipx install docsgpt