Command-line tool

sedisto-pcli

A command-line interface for the sedisto Portal API. Manage sites, tenants, rental agreements, and more — directly from your terminal.

Documentation and what’s new

macOS

Apple Silicon (arm64) Intel (amd64)

Linux

x86_64 (amd64) ARM64

Windows

x86_64 (amd64) ARM64

1 Installation

Download the binary for your platform above and make it executable:

# macOS / Linux
chmod +x sedisto-pcli_darwin_arm64
mv sedisto-pcli_darwin_arm64 /usr/local/bin/sedisto-pcli

On Windows, rename the downloaded .exe and add it to your PATH.

macOS: these binaries are not signed

They carry only the ad-hoc signature the Go linker adds — there is no Apple Developer ID behind them — so macOS refuses to run a copy your browser downloaded, with “Apple could not verify that this app is free of malware”. Remove the mark your browser put on the file, once:

xattr -d com.apple.quarantine /usr/local/bin/sedisto-pcli

That removes the browser's note that the file came from the internet — it does not make the binary trusted, so verify the checksum below instead of taking our word for it. sedisto-pcli update is unaffected: it downloads the binary itself, and nothing marks it.

Verify what you downloaded against checksums.txt, in the directory you downloaded into:

shasum -a 256 -c --ignore-missing checksums.txt

Verify the installation:

sedisto-pcli version

2 Configuration

Create a config file at ~/.sedisto-pcli.yaml:

api_url: https://your-instance.sedisto.net
api_key: your-api-key

Or use environment variables:

export SEDISTO_API_URL=https://your-instance.sedisto.net
export SEDISTO_API_KEY=your-api-key

3 Usage

Every method and option the API offers is here. The commands, their flags and the values those flags accept are generated from the same OpenAPI contract the API reference renders, on every release — so there is no subset to learn, and nothing on this page to fall out of date.

Browse the API reference — every endpoint, filter and field, for the exact release your installation runs.

Ask your instance which that is with GET /version; there is deliberately no “latest”, because an installation runs the release it was deployed with.

sedisto-pcli --help lists the resource groups this binary was built with, and --help on any command gives its flags and their accepted values. That is the same contract, read from the binary in your hand.

Example — list all active sites:

sedisto-pcli sites list

All list commands support pagination (max 100 per page):

sedisto-pcli tenants list --page 2 --per-page 100

4 Updating

The CLI can update itself. It checks for a new release and atomically replaces the running binary:

sedisto-pcli update