Quickstart
Install
macOS and Linux:
curl -fsSL https://sankh.dev/install.sh | sh # or: brew install sankh-dev/tap/sankhWindows (PowerShell):
powershell -ExecutionPolicy Bypass -c "irm https://github.com/sankh-dev/sankh/releases/latest/download/sankh-installer.ps1 | iex"Sankh needs nothing else at run time: no shell and no curl.
Prefer a native window? The desktop app is the same UI as
sankh serve, for macOS, Windows and Linux. Install has every
option for the CLI and the app per OS (Homebrew, .deb, .rpm, AppImage,
.msi, manual download, building from source), plus upgrading and
uninstalling.
Your first collection
sankh init my-api # scaffold a collection
sankh run my-api --check # check every file without sending anything
sankh run my-api --env dev # run everything, exit non-zero on failure
sankh serve my-api # web UI on http://localhost:4747
sankh workspace add my-api # or keep it, so plain `sankh serve` opens itAlready have a Postman collection? Convert it with
sankh import postman collection.json -o my-api (see
Import from Postman).
A collection is a plain folder of .sh files, each holding one curl command:
#!/usr/bin/env bash
# @name Create pet
# @tags smoke
# @expect status 201
# @expect json .name == "Rex"
# @capture PET_ID=.id
curl -sS "$BASE_URL/pets" \
-H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
-d '{"name":"Rex"}'Every file still runs on its own, with or without Sankh:
set -a; . environments/dev.env; set +a
sh pets/02-create.shThe full file format, including every annotation, is described in
Collection format. For a walkthrough of @expect, @capture
and chaining requests into a flow, see
Assertions and chaining.
Try the bundled example
The repository ships a petstore collection and an in-memory mock server:
cargo run --example petstore_mock & # http://localhost:4010
cp examples/petstore/.env.example examples/petstore/.env.local
sankh run examples/petstoreHow it runs a file
Sankh never modifies or executes a request file. It reads the annotations and
the curl command, expands $VAR from the environment, and sends the request
with its own HTTP client. Every flag must be one it supports (see
curl flags); anything it cannot honor, and any shell syntax
such as a pipe, is an error that points at the line and column.
Next steps
- Assertions and chaining: check responses and pass values between requests.
- Running in CI: flags, reports and exit codes.
- Web UI: editing and running requests in the browser.
- Desktop app: the same UI in a native window.
- Workspaces: several collections side by side, and Scratch.
- Import from Postman: convert an existing collection.
- curl flags: which curl options Sankh understands.
- Secrets and safety: what a request file can do and what Sankh hides.