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_64andarm64) - 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 |
mcp |
Run the Baseshift MCP server on stdio |
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 telemetryBASESHIFT_HELM_BIN— override the bundled Helm binary used bydub validate-values
MCP
baseshift mcp runs an MCP server on stdio (start/stop clones and related
tools). Log in with baseshift auth login first. Example Cursor config:
{
"mcpServers": {
"baseshift": {
"command": "baseshift",
"args": ["mcp"]
}
}
}
Links
- Product: baseshift.com
- App: app.baseshift.com
- PyPI: pypi.org/project/baseshift
License
BSD 2-Clause. See LICENSE, THIRD-PARTY-NOTICES, and
LICENSES-Apache-2.0-Helm.txt (bundled Helm).
1 maintainer
Metadata
1 maintainer
Release files for baseshift 3.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| baseshift-3.6.0-py3-none-win_amd64.whl | Python 3 | none | Windows x86-64 | Details |
| baseshift-3.6.0-py3-none-manylinux2014_x86_64.whl | Python 3 | none | Linux glibc 2.17+ x86-64 | Details |
| baseshift-3.6.0-py3-none-manylinux2014_aarch64.whl | Python 3 | none | Linux glibc 2.17+ ARM64 | Details |
| baseshift-3.6.0-py3-none-macosx_11_0_arm64.whl | Python 3 | none | macOS 11.0+ ARM64 | Details |
| baseshift-3.6.0-py3-none-macosx_10_9_x86_64.whl | Python 3 | none | macOS 10.9+ x86-64 | Details |
Total release size: 104.9 MB
Release files / baseshift-3.6.0-py3-none-win_amd64.whl
| Download URL | baseshift-3.6.0-py3-none-win_amd64.whl |
|---|---|
| Size | 21.6 MB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
2e686436737735d210ee37b00609bb49929900080eb2e11c0ef227f8fd9d3474
|
|
BLAKE2b-256 checksum How to use checksums |
e2db5bc2c0a4875b3aa6948b90a358c4f322070b248a4127d256d3dede1f51fc
|
| 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.6.0-py3-none-manylinux2014_x86_64.whl
| Download URL | baseshift-3.6.0-py3-none-manylinux2014_x86_64.whl |
|---|---|
| Size | 21.2 MB |
| Tags | Linux glibc 2.17+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
407cabb7d3f1a5b8df3694f49d1a5e3a47a05152314e0f6973c67986f025eb25
|
|
BLAKE2b-256 checksum How to use checksums |
582c7a0adb885662fe73b1db3347e15c8fdfe68e5ce2f7aa8753fc723f4c773a
|
| 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.6.0-py3-none-manylinux2014_aarch64.whl
| Download URL | baseshift-3.6.0-py3-none-manylinux2014_aarch64.whl |
|---|---|
| Size | 19.2 MB |
| Tags | Linux glibc 2.17+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
eac1a87c371d4020fb2d117d7f080816b8bf18fdb7b80f83846f511fb3ceb436
|
|
BLAKE2b-256 checksum How to use checksums |
0fe30f549361b5221237a49be814164aa6f9f2018132fd06d6fcfbcbf65c6ee3
|
| 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.6.0-py3-none-macosx_11_0_arm64.whl
| Download URL | baseshift-3.6.0-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 20.9 MB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
cbbad04d0c5ed79697da7963b0f2ee8ad5f4bff9fe27a75e40915103a730df31
|
|
BLAKE2b-256 checksum How to use checksums |
a90396f6e2d34a6c449b1d5d840a425724d686c66a5f9c9873465d0917f854b4
|
| 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.6.0-py3-none-macosx_10_9_x86_64.whl
| Download URL | baseshift-3.6.0-py3-none-macosx_10_9_x86_64.whl |
|---|---|
| Size | 22.0 MB |
| Tags | Python 3 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
79d5df9208efe0272da55e93fed53c7a3a595a50995c419d11a11059b75ac854
|
|
BLAKE2b-256 checksum How to use checksums |
8e30d6d9e57394db502436bc300c57207060f0ddd92a7304755dd14afaa1ac6d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.5
|
