Skip to content

docs: add LanceDB pre-release install instructions #289

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

Open
prrao87 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add LanceDB pre-release install instructions #289

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
36 changes: 34 additions & 2 deletions docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,15 @@ runs in-process (like SQLite). Let's get started in just a few steps!
Install LanceDB in your client SDK.

<CodeGroup>
```bash Python icon=Python
pip install lancedb # or uv add lancedb
```bash uv icon="terminal"
uv add lancedb

# Or, in an existing virtual environment:
uv pip install lancedb
```

```bash pip icon="terminal"
pip install lancedb
```

```bash TypeScript icon=js
Expand All @@ -51,6 +58,31 @@ cargo add lancedb
```
</CodeGroup>

### Python pre-release builds

Stable LanceDB releases are created about every 2 weeks. To pick up the latest features and bug fixes
before the next stable release, install a pre-release from LanceDB's Fury index.

<CodeGroup>
```bash pip icon="terminal"
pip install --pre --extra-index-url https://pypi.fury.io/lancedb/ lancedb
```

```bash uv icon="terminal"
uv venv
uv pip install --prerelease allow --index https://pypi.fury.io/lancedb/ lancedb

# To add to pyproject.toml, use:
uv add --prerelease allow --index https://pypi.fury.io/lancedb/ lancedb
```
</CodeGroup>

<Note>
Pre-release builds receive the same level of testing as stable releases, but are not guaranteed to
remain available for more than 6 months after release. Once your application is stable, switch back
to stable releases.
</Note>

## 2. Connect to a LanceDB database

LanceDB supports several URI patterns to connect to a database.
Expand Down
Loading