Skip to content

Latest commit

 

History

History
259 lines (166 loc) · 6.63 KB

File metadata and controls

259 lines (166 loc) · 6.63 KB

Installation

dbc is installable on the most common platforms and from a variety of sources.

Standalone Installer

We provide an automated command-line installer for users who prefer it. Please continue reading for other installation methods.

The following commands will automatically install the latest version of dbc suitable for your system and place it in a standard location for you.

=== "macOS and Linux"

To automatically install dbc, run:

```console
$ curl -LsSf https://dbc.columnar.tech/install.sh | sh
```

If your system doesn't have `curl` you can also use `wget`:

```console
$ wget -q0- https://dbc.columnar.tech/install.sh | sh
```

If you want to inspect the script before use, you can simply run:

```console
$ curl -LsSf https://dbc.columnar.tech/install.sh | less
```

=== "Windows"

Use `irm` to download the script and execute it with `iex`:

```console
$ powershell -ExecutionPolicy ByPass -c "irm https://dbc.columnar.tech/install.ps1 | iex"
```

Changing the [execution policy](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.4#powershell-execution-policies) allows running a script from the internet.

Of course, you can also inspect the script before use:

```console
$ powershell -c "irm https://dbc.columnar.tech/install.ps1 | more"
```

PyPI

dbc is published on PyPI as dbc for convenience. The package contains the appropriate dbc executable for your system and makes it available to various tools in the Python ecosystem.

uv

To run dbc with uv, you can run either of the following:

$ uv tool run dbc
$ uvx dbc

To install dbc as a uv tool, run:

$ uv tool install dbc
$ # Now run dbc with
$ dbc

To learn more about uv tool, see uv's Tools documentation.

pipx

To install dbc with pipx, run,

$ pipx install dbc

If you only want to run dbc to test it out, run,

$ pipx run dbc

Virtual Environment

Installing dbc inside a virtual environment automatically handles installing dbc and adding it to your $PATH:

$ python -m venv .venv
$ source .venv/bin/activate
$ pip install dbc

GitHub Releases

All dbc release artifacts are can be found at GitHub Releases. We always recommend installing dbc from the latest release.

Windows Installer

A Windows MSI installer for x86_64 (i.e., x64, amd64) systems can be found as artifacts in our GitHub Releases. You can also download the latest installer using the following URL:

Architecture Link
x64 https://dbc.columnar.tech/latest/dbc-latest-x64.msi

!!! note

Starting with dbc 0.2.0, the MSI installer only supports per-user installs. The 0.1.0 MSI installed system-wide.

WinGet

On Windows, you can install dbc using WinGet:

$ winget install Columnar.dbc

!!! note

If you installed dbc 0.1.0 with WinGet, it was installed system-wide and `winget upgrade dbc` cannot upgrade it. Uninstall the system-level package first, then install again:

```console
$ winget uninstall --id Columnar.dbc
$ winget install Columnar.dbc
```

Docker

We publish Docker images for each dbc release.

Run the latest version of dbc under Docker by running:

$ docker run --rm -it columnar/dbc:latest --help

Available Images

The following distroless images are available for Linux-based amd64 and arm64 architectures:

  • columnar/dbc:latest
  • columnar/dbc:{major}, e.g. columnar/dbc:1
  • columnar/dbc:{major}.{minor}, e.g. columnar/dbc:0.1
  • columnar/dbc:{major}.{minor}.{patch}, e.g. columnar/dbc:0.0.1

Homebrew

You can install dbc from our Homebrew tap by running:

$ brew install columnar-tech/tap/dbc

Shell Completions

dbc can generate shell completions for a number of common shells.

!!! note

If you aren't sure what shell you're running, you can run the following command in your terminal:

```console
$ echo $SHELL
```

=== "Bash"

```console
$ echo 'eval "$(dbc completion bash)"' >> ~/.bashrc
```

=== "Zsh"

```console
$ echo 'eval "$(dbc completion zsh)"' >> ~/.zshrc
```

=== "fish"

```console
$ dbc completion fish > ~/.config/fish/completions/dbc.fish
```

!!! info

You can use the `dbc completion` subcommand to print extended instructions for your shell, including how to enable your shell's completion mechanism. For example, to print setup instructions for Bash, run `dbc completion bash --help`.

Uninstallation

To remove dbc from your system, run the uninstall command corresponding to your installation method.

=== "Linux/macOS shell"

```console
$ rm $HOME/.local/bin/dbc
```

=== "Windows shell"

```console
$ powershell.exe -c "rm $HOME/.local/bin/dbc.exe"
```

=== "Windows MSI"

Go to **Settings** > **Apps** > **Installed apps** (or **Control Panel** > **Programs and Features**), select dbc, and click **Uninstall**.

=== "WinGet"

```console
$ winget uninstall dbc
```

=== "uv"

```console
$ uv tool uninstall dbc
```

=== "pipx"

```console
$ pipx uninstall dbc
```

=== "pip"

```console
$ pip uninstall dbc
```

=== "Homebrew"

```console
$ brew uninstall --cask dbc
```

!!! note

Uninstalling dbc does not remove any drivers you've installed with either `dbc install` or `dbc sync`. To remove drivers, run [`dbc uninstall`](../reference/cli.md#uninstall) on each installed driver prior to uninstalling dbc.