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.2

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.2
File Actions
baseshift-3.8.2-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for baseshift-3.8.2-py3-none-win_amd64.whl
baseshift-3.8.2-py3-none-manylinux2014_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details for baseshift-3.8.2-py3-none-manylinux2014_x86_64.whl
baseshift-3.8.2-py3-none-manylinux2014_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64 Details for baseshift-3.8.2-py3-none-manylinux2014_aarch64.whl
baseshift-3.8.2-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for baseshift-3.8.2-py3-none-macosx_11_0_arm64.whl
baseshift-3.8.2-py3-none-macosx_10_9_x86_64.whl Python 3 none macOS 10.9+ x86-64 Details for baseshift-3.8.2-py3-none-macosx_10_9_x86_64.whl

Total release size: 107.9 MB

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

Download URL baseshift-3.8.2-py3-none-win_amd64.whl
Size 22.2 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
4a2a237f6baaef153c1914b20ae94fa5c207af1e08013874bf2f419daaddef05
BLAKE2b-256 checksum
How to use checksums
de6304cd02a806bb0215fe3e9512129ba1f3cf5fd90f3ce5d0df08a42bdb4945
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.2-py3-none-manylinux2014_x86_64.whl

Download URL baseshift-3.8.2-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
25f875ce5e946d89eafcfd3fd9a65ffbc3f93dc3e4ee544fd4a0986a812ec52d
BLAKE2b-256 checksum
How to use checksums
40456e4de411682ccb66221684a46e8a434a3e9cacb690ef90af52f9aed4a063
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.2-py3-none-manylinux2014_aarch64.whl

Download URL baseshift-3.8.2-py3-none-manylinux2014_aarch64.whl
Size 19.8 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
85ba3a7b228ba92edc706543e5656a5d15146317a190a6998196df80ea527eb2
BLAKE2b-256 checksum
How to use checksums
3470ab34721cf41f6b6b48fc74869efc719b9ebe3670c2b39cbdeb6dda197a4f
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.2-py3-none-macosx_11_0_arm64.whl

Download URL baseshift-3.8.2-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
d53084681597a9883257ce8b7184d5cb72b0656cb298b54e8a41b870fadcfa55
BLAKE2b-256 checksum
How to use checksums
f9e26a87558bb92d3623c54df08dde0418c042306f79bfea8cb44fb89d3af13c
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.2-py3-none-macosx_10_9_x86_64.whl

Download URL baseshift-3.8.2-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
d7ff75c4cc3085dc2aa1593fd38679eb0e6b8d9880493d7485428135fedac74e
BLAKE2b-256 checksum
How to use checksums
4c526706a7a2f98539fbadbe4f8d577e4716de378188a9b58341ce91845fb2c9
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.2

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.2 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