Skip to content

Commit 17c60bb

Browse files
docs: update install one-liner to use deepsql.ai URL (#119)
<!-- CURSOR_AGENT_PR_BODY_BEGIN --> ## Summary Updates the public installation documentation to use `https://deepsql.ai/install.sh` as the primary one-liner URL instead of the raw GitHub URL. ## Changes ### README.md - Changed the Quick start one-liner from: ```bash curl -fsSL https://raw.githubusercontent.com/DeepSQLAI/deepsql/main/scripts/self-host/remote-install.sh | bash ``` to: ```bash curl -fsSL https://deepsql.ai/install.sh | bash ``` - Added a note clarifying that `scripts/self-host/remote-install.sh` is the source of truth, with `deepsql.ai/install.sh` serving a copy for the homepage CTA ### scripts/self-host/remote-install.sh - Updated header comments to document `https://deepsql.ai/install.sh` as the primary install URL - Added the raw GitHub URL as a documented fallback option - Updated `--help` examples to prefer the deepsql.ai URL - Updated the "re-run this installer" hint in the Docker check to use the deepsql.ai URL ## Why The `deepsql.ai` URL is shorter, more memorable, and better for homepage branding. The raw GitHub URL remains documented as a fallback for users who may have connectivity issues reaching deepsql.ai. ## Testing Documentation-only change. Verified both files have correct syntax and the URLs are properly formatted. <!-- CURSOR_AGENT_PR_BODY_END --> <div><a href="https://cursor.com/agents/bc-361f9d22-2666-5bff-9616-7f7e8feab9b3?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-web-light.png"><img alt="Open in Web" width="114" height="28" src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a href="https://cursor.com/background-agent?bcId=bc-361f9d22-2666-5bff-9616-7f7e8feab9b3&cursor_ref=pr_footer&cursor_cta=open_in_cursor"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img alt="Open in Cursor" width="131" height="28" src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a>&nbsp;</div> Co-authored-by: Cursor Agent <cursoragent@cursor.com>
1 parent 4b05812 commit 17c60bb

2 files changed

Lines changed: 16 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,16 @@ DeepSQL Desktop first ship + Agent/Brain/Editor hardening. Notes:
2626
### One-liner install
2727

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

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

36+
> The script source of truth is [`scripts/self-host/remote-install.sh`](scripts/self-host/remote-install.sh)
37+
> in this repository. `deepsql.ai/install.sh` serves a copy for the homepage CTA.
38+
3639
### Step-by-step
3740

3841
Five steps, in order. Budget about fifteen minutes, most of it waiting on the first build.

‎scripts/self-host/remote-install.sh‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@
44
# ═══════════════════════════════════════════════════════════════════════════════
55
#
66
# One-liner install:
7+
# curl -fsSL https://deepsql.ai/install.sh | bash
8+
#
9+
# Fallback (raw GitHub URL):
710
# curl -fsSL https://raw.githubusercontent.com/DeepSQLAI/deepsql/main/scripts/self-host/remote-install.sh | bash
811
#
9-
# This script is a convenience wrapper. The source of truth is the public GitHub
10-
# repository: https://github.com/DeepSQLAI/deepsql
12+
# This script is the source of truth. deepsql.ai/install.sh serves a copy for the
13+
# homepage CTA. The public GitHub repository: https://github.com/DeepSQLAI/deepsql
1114
#
1215
# You can always clone and build manually instead:
1316
# git clone https://github.com/DeepSQLAI/deepsql.git
@@ -118,7 +121,7 @@ check_docker() {
118121
echo " curl -fsSL https://get.docker.com | sh"
119122
echo
120123
echo "After installing Docker, re-run this installer:"
121-
echo " curl -fsSL https://raw.githubusercontent.com/${DEEPSQL_REPO}/main/scripts/self-host/remote-install.sh | bash"
124+
echo " curl -fsSL https://deepsql.ai/install.sh | bash"
122125
elif [[ "$OS_TYPE" == "darwin" ]]; then
123126
echo "Install Docker Desktop for Mac from:"
124127
echo " https://www.docker.com/products/docker-desktop"
@@ -388,13 +391,16 @@ Environment variables:
388391
389392
Examples:
390393
# Interactive setup (edit .env, then run install.sh yourself)
391-
curl -fsSL https://raw.githubusercontent.com/DeepSQLAI/deepsql/main/scripts/self-host/remote-install.sh | bash
394+
curl -fsSL https://deepsql.ai/install.sh | bash
392395
393396
# Noninteractive (requires .env to be pre-configured or prompts)
394-
curl -fsSL .../remote-install.sh | bash -s -- --yes
397+
curl -fsSL https://deepsql.ai/install.sh | bash -s -- --yes
395398
396399
# Install a specific version
397-
curl -fsSL .../remote-install.sh | bash -s -- --branch v1.3.0
400+
curl -fsSL https://deepsql.ai/install.sh | bash -s -- --branch v1.3.0
401+
402+
# Fallback: raw GitHub URL (if deepsql.ai is unreachable)
403+
curl -fsSL https://raw.githubusercontent.com/DeepSQLAI/deepsql/main/scripts/self-host/remote-install.sh | bash
398404
EOF
399405
}
400406

0 commit comments

Comments
 (0)