Getting Started

Planck is the reference implementation of Zero Distance Architecture, where, code runs in the same process as data, every query is a function call, and the unit of deployment is one binary. Whatever you're building (a monolith, microservices, or Self-Contained Systems), each unit is one Planck.

This page takes you from zero to a running Planck, then through your first deployed service and app, then into upgrade/uninstall and operational reference. Read top to bottom on first install; come back to specific sections later.

Planck ships as a single tarball (or zip on Windows) containing the database engine, the workbench (control plane + web UI), and the deploy CLI. Installing it registers the workbench as an OS service; the workbench then supervises the system DB and every user-deployed service.

---

Downloads

OS	amd64	arm64
Linux	planck-amd64-linux	planck-arm64-linux
macOS	X	planck-arm64-macos
Windows	planck-amd64-windows	X

macOS / Linux

After file is downloaded, create a folder by running bwlow command

sudo mkdir -p /opt/planck

macOS

sudo tar -xzf ~/<download dir>/planck-0.1.0-macos-arm64.tar.gz  -C /opt/planck --strip-components=1

Linux

sudo tar -xzf ~/<download dir>/planck-0.1.0-linux-arm64.tar.gz  -C /opt/planck --strip-components=1

Now open the .bashrc or .zshrc whichever you are using and add below line to it and save.

export PATH="/opt/planck/bin:$PATH"

Windows (PowerShell as Administrator)

After file is downloaded, create a folder by running bwlow command

mkdir -p 'C:\Program Files\Planck'

And now, extract the downloaded zip file using below powershell commands.

mkdir -p 'C:\Program Files\Planck'
Expand-Archive -Path "$HOME\<download dir>\planck-0.1.0-windows-amd64.zip" -DestinationPath "C:\Program Files\Planck"

Now open the Advance System Settings, navigate to Environment Variables and add new path C:\Program Files\Planck\bin in both User Variable and System variables sections.

---

Now, before we start setting up Planck System, lets understand what are Roles.

Roles (cluster topology)

Planck supports three roles:

Role	What it does
standalone	Single node. Workbench + system DB on one host. Default.
command	Write-side of a command/query split. Replicates to a query node.
query	Read-side. Receives replication from a command node.

install - for macOS/Linux and Windows

#install just a standalone node
planctl system install --role standalone 

# if you want to install both query and command node on same machine
planctl system install --role query --node same 
planctl system install --role command --node same 

# if you want to install query and command node on different machine
planctl system install --role query --node same 
planctl system install --role command --node same --host <query host address>

uninstall - for macOS/Linux and Windows

Uninstall, just deletes the services and keep the binaries asis, you have to use OS commands to remove it carefully.

planctl system uninstall

stop - for macOS/Linux and Windows

To Stop all the services use below command

planctl system stop

start - for macOS/Linux and Windows

To Start all the services use below command

planctl system start