Skip to main content

baseshift

Command-line client for Baseshift. Create dubs (masked or subsetted copies of a source database), take snapshots, and start clones for development and testing.

Install

pip install baseshift

Platform wheels ship for:

  • macOS (Intel and Apple Silicon)
  • Linux (x86_64 and arm64)
  • Windows (amd64)

The default install talks to clones over WireGuard. For Tailscale, install the companion extra so both packages stay on the same version:

pip install 'baseshift[ts]'

Confirm the install:

baseshift --version
baseshift --help

Quick start

# Browser OAuth (default). Use --method=direct for email/password.
baseshift auth login

# Optional: write ~/.baseshift/config (org token and default dub)
baseshift init

# Create a cloud dub with demo data, or point at your own Postgres.
baseshift dub create --name my-dub --use-demo-db --encryption-password MyKey123
baseshift dub list

# Snapshot, then start a clone and print connection details.
baseshift snapshot create --dub my-dub --wait
baseshift server-clone start --dub my-dub
baseshift server-clone list --dub my-dub
baseshift server-clone stop

--dub accepts a name or a UUID. A name is resolved by the API; pass --org-token (or set BASESHIFT_ORG_TOKEN / orgToken in config) when the same name exists in more than one org. A UUID never needs --org-token.

dub create and dub list use your only organization when --org-token is omitted. When you belong to more than one organization, pass --org-token.

Commands

Command What it does
auth Log in, log out, and check authentication status
init Create ~/.baseshift/config with default org and dub
dub Create and manage dubs (cloud or self-hosted Helm)
data-env Create and manage data environments and their snapshots
server-clone Start, stop, and list clones on Baseshift servers
local-clone Pull or run a dub's snapshot image with local Docker
snapshot Create, check, and list snapshots of a dub

Run baseshift <command> --help (and baseshift dub create -h) for flags. Common dub actions: create, list, describe, status, health-check, validate-values, configure-source, subset, masking.

Cloud dub against your database

baseshift dub create --name my-dub \
  --hostname mydb.example.com --database acme --username app \
  --password-stdin --encryption-password MyKey123

Self-hosted dub (Helm values)

baseshift dub create --deployment self-hosted --name my-onprem-dub \
  --hostname mydb.example.com --database acme --username dubhub \
  --password-stdin --registry-type none
baseshift dub validate-values --values-file values.yaml

Local Docker clone

baseshift local-clone pull --dub my-dub
baseshift local-clone run --dub my-dub -- --publish 5432:5432

Configuration

Values resolve as CLI flag → environment variable → ~/.baseshift/config → default.

baseshift init writes JSON to ~/.baseshift/config:

{
    "orgToken": "<org-uuid>",
    "dubUuid": "<dub-uuid>"
}
Setting Flag Environment Config key
Organization --org-token BASESHIFT_ORG_TOKEN orgToken
Default dub --dub / --dub-uuid BASESHIFT_DUB_UUID dubUuid

Useful environment variables:

  • BASESHIFT_VERBOSE=1 — DEBUG logs and full tracebacks (same as -v)
  • BASESHIFT_DISABLE_SENTRY=1 — disable error telemetry
  • BASESHIFT_HELM_BIN — override the bundled Helm binary used by dub validate-values

License

BSD 2-Clause. See LICENSE, THIRD-PARTY-NOTICES, and LICENSES-Apache-2.0-Helm.txt (bundled Helm).

Metadata

Release files for baseshift 3.8.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for baseshift 3.8.3
File Actions
baseshift-3.8.3-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for baseshift-3.8.3-py3-none-win_amd64.whl
baseshift-3.8.3-py3-none-manylinux2014_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details for baseshift-3.8.3-py3-none-manylinux2014_x86_64.whl
baseshift-3.8.3-py3-none-manylinux2014_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64 Details for baseshift-3.8.3-py3-none-manylinux2014_aarch64.whl
baseshift-3.8.3-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for baseshift-3.8.3-py3-none-macosx_11_0_arm64.whl
baseshift-3.8.3-py3-none-macosx_10_9_x86_64.whl Python 3 none macOS 10.9+ x86-64 Details for baseshift-3.8.3-py3-none-macosx_10_9_x86_64.whl

Total release size: 107.9 MB

Release files / baseshift-3.8.3-py3-none-win_amd64.whl

Download URL baseshift-3.8.3-py3-none-win_amd64.whl
Size 22.2 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
496e580b0bfc2321f78b60e35d954eceb03cbea841ad71c0d0954d4a578a1ab9
BLAKE2b-256 checksum
How to use checksums
144221063e6714d5b93759ac365d83675d3cd10c93ce080881e70a55a4935cf5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / baseshift-3.8.3-py3-none-manylinux2014_x86_64.whl

Download URL baseshift-3.8.3-py3-none-manylinux2014_x86_64.whl
Size 21.8 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
b738068fba718b4ec4e4a6af73bedb4ab04df36bc441595434d507eb936d3d85
BLAKE2b-256 checksum
How to use checksums
0fd9804acd6a86510ba32cddf765eb8f305605359a03399cbb90edda9e90668a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / baseshift-3.8.3-py3-none-manylinux2014_aarch64.whl

Download URL baseshift-3.8.3-py3-none-manylinux2014_aarch64.whl
Size 19.8 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
bd42e6ab489455c41662d124543f17c309d54defa12a4418aea6137442f140d0
BLAKE2b-256 checksum
How to use checksums
b2b4319ec77000b2cad3ce02266a194fad4bb7f7287f4638176f0caefda81e1a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / baseshift-3.8.3-py3-none-macosx_11_0_arm64.whl

Download URL baseshift-3.8.3-py3-none-macosx_11_0_arm64.whl
Size 21.4 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
ac51731ef67b6368049a1f3d49f35ca9073c07ab71d233353d0f1ea6ce7bfe71
BLAKE2b-256 checksum
How to use checksums
7a90987c81396d6a3944a32806640b1d9d9108a09a4940ee30a44b22be55e4ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / baseshift-3.8.3-py3-none-macosx_10_9_x86_64.whl

Download URL baseshift-3.8.3-py3-none-macosx_10_9_x86_64.whl
Size 22.6 MB
Tags Python 3 macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
a3471ea0387af3dbc3351f530d21b03dccbf443988e02ab294b472bd57f6c59d
BLAKE2b-256 checksum
How to use checksums
67eb70ca1d7ceb0c80904949cfdea75ec8adf8cece87fb266b14b4a8155e42b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Security for baseshift 3.8.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.8.3 This release

5 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page