Skip to content

docs: update install one-liner to use deepsql.ai URL #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
venkateshsakamuri-lab merged 1 commit into from
Sep 22, 2026
Merged

docs: update install one-liner to use deepsql.ai URL #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,16 @@ DeepSQL Desktop first ship + Agent/Brain/Editor hardening. Notes:
### One-liner install

```bash
curl -fsSL https://raw.githubusercontent.com/DeepSQLAI/deepsql/main/scripts/self-host/remote-install.sh | bash
curl -fsSL https://deepsql.ai/install.sh | bash
```

This checks prerequisites, clones the latest release to `~/deepsql`, and guides you
through configuration. See [`scripts/self-host/remote-install.sh`](scripts/self-host/remote-install.sh)
for options (`--yes` for noninteractive, `--branch` for a specific version).

> The script source of truth is [`scripts/self-host/remote-install.sh`](scripts/self-host/remote-install.sh)
> in this repository. `deepsql.ai/install.sh` serves a copy for the homepage CTA.

### Step-by-step

Five steps, in order. Budget about fifteen minutes, most of it waiting on the first build.
Expand Down
18 changes: 12 additions & 6 deletions scripts/self-host/remote-install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@
# ═══════════════════════════════════════════════════════════════════════════════
#
# One-liner install:
# curl -fsSL https://deepsql.ai/install.sh | bash
#
# Fallback (raw GitHub URL):
# curl -fsSL https://raw.githubusercontent.com/DeepSQLAI/deepsql/main/scripts/self-host/remote-install.sh | bash
#
# This script is a convenience wrapper. The source of truth is the public GitHub
# repository: https://github.com/DeepSQLAI/deepsql
# This script is the source of truth. deepsql.ai/install.sh serves a copy for the
# homepage CTA. The public GitHub repository: https://github.com/DeepSQLAI/deepsql
#
# You can always clone and build manually instead:
# git clone https://github.com/DeepSQLAI/deepsql.git
Expand Down Expand Up @@ -118,7 +121,7 @@ check_docker() {
echo " curl -fsSL https://get.docker.com | sh"
echo
echo "After installing Docker, re-run this installer:"
echo " curl -fsSL https://raw.githubusercontent.com/${DEEPSQL_REPO}/main/scripts/self-host/remote-install.sh | bash"
echo " curl -fsSL https://deepsql.ai/install.sh | bash"
elif [[ "$OS_TYPE" == "darwin" ]]; then
echo "Install Docker Desktop for Mac from:"
echo " https://www.docker.com/products/docker-desktop"
Expand Down Expand Up @@ -388,13 +391,16 @@ Environment variables:

Examples:
# Interactive setup (edit .env, then run install.sh yourself)
curl -fsSL https://raw.githubusercontent.com/DeepSQLAI/deepsql/main/scripts/self-host/remote-install.sh | bash
curl -fsSL https://deepsql.ai/install.sh | bash

# Noninteractive (requires .env to be pre-configured or prompts)
curl -fsSL .../remote-install.sh | bash -s -- --yes
curl -fsSL https://deepsql.ai/install.sh | bash -s -- --yes

# Install a specific version
curl -fsSL .../remote-install.sh | bash -s -- --branch v1.3.0
curl -fsSL https://deepsql.ai/install.sh | bash -s -- --branch v1.3.0

# Fallback: raw GitHub URL (if deepsql.ai is unreachable)
curl -fsSL https://raw.githubusercontent.com/DeepSQLAI/deepsql/main/scripts/self-host/remote-install.sh | bash
EOF
}

Expand Down
Loading