Praxicraft Assess — hiring workspace docs

Official CLI for the Assess Public API. Invite candidates, manage assessments and pipelines, work with webhooks and interviews, and automate hiring workflows from your terminal. Binary: praxicraft-assess. Source and releases: praxicraft-assess-cli. You need an organisation API key (ct_live_… or ct_test_…) from Assess → Developer → API Keys.

Install

npm

npm install -g @praxicraft/assess-cli
# or
bun add -g @praxicraft/assess-cli

The interactive TUI requires Bun ≥ 1.1 on your PATH (the package shebang is bun).

Binary installer

curl -fsSL https://praxicraft.com/install.sh | sh && export PATH="$HOME/.local/bin:$PATH"

That installs the latest GitHub Release binary (with SHA-256 check) as praxicraft-assess to ~/.local/bin or /usr/local/bin. The trailing export activates PATH in the current terminal. curl | sh alone cannot change your parent shell’s environment. Optional:

# specific version
curl -fsSL https://praxicraft.com/install.sh | PRAXICRAFT_VERSION=v2.0.0 sh

# custom directory
curl -fsSL https://praxicraft.com/install.sh | PRAXICRAFT_INSTALL_DIR="$HOME/bin" sh

Manual (GitHub Releases)

Download praxicraft-assess-{os}-{arch} from Releases (for example praxicraft-assess-darwin-arm64), chmod +x, and put it on your PATH as praxicraft-assess.

From source

git clone https://github.com/praxicraft-platform/praxicraft-assess-cli.git
cd praxicraft-assess-cli
bun install
bun run src/index.ts

Requires Bun ≥ 1.1.

Configure

praxicraft-assess configure

Or set environment variables:

export PRAXICRAFT_API_KEY="ct_test_xxxxxxxxxxxxxxxx"
# optional
export PRAXICRAFT_API_BASE_URL="https://assess.praxicraft.com"

Profiles are stored in ~/.config/praxicraft/config.toml. Use --profile to switch between them.

praxicraft-assess whoami

Quickstart

praxicraft-assess org get
praxicraft-assess assessments list --output table
praxicraft-assess invites create senior-backend-screen --email [email protected] --name "Jane Doe"
praxicraft-assess invites result <invite-token>

Run praxicraft-assess with no arguments to open an interactive shell (command palette + Ask AI).

Ask AI

Type naturally to ask the assistant, or / for slash commands (for example /login, /assessments list). Ask AI uses your Assess API key against POST /api/v1/public/assistant/chat/ (Starter+, scope assistant:write) and:

Points the model at the docs index: llms.txt
Loads Knowledge MCP (https://docs.praxicraft.com/mcp) plus Assess API tools (@praxicraft/assess-mcp)

Use it for “how do I invite…”, scope questions, webhook recipes, and CLI command help grounded in current docs. JSON bodies for create/update:

praxicraft-assess assessments create --body '{"title":"Backend screen"}'
praxicraft-assess assessments create --body-file ./assessment.json

Commands

Group	What you can do
`org`	Profile, stats, team, audit log, squads
`assessments`	List, create, update, duplicate, tasks, results
`invites`	Create, bulk create, list, remind, cancel, result
`results`	List by assessment, get by invite token
`tasks`	Platform and organisation tasks
`pipelines`	Enroll, bulk enroll, hold, reject, enrollments
`webhooks`	Endpoints, test pings, deliveries, retries
`interviews`	Rooms, templates, analysis, share, cancel
`integrations`	Connected ATS providers

Run praxicraft-assess <command> --help for flags on any command.

Useful flags

Flag	Description
`--api-key`	API key (overrides env / config)
`--base-url`	API host (default `https://assess.praxicraft.com`)
`--profile`	Named config profile
`--output`	`json`, `table`, or `yaml`
`--query`	JMESPath filter on JSON output
`--yes`	Skip confirmation prompts
`--non-interactive`	Disable prompts (CI-friendly)

Examples

More recipes (SDKs, curl, n8n, Zapier) live in praxicraft-assess-examples.

Authentication · SDKs · API Reference · Verify webhooks

Official clients

CLI

Install

npm

Binary installer

Manual (GitHub Releases)

From source

Configure

Quickstart

Ask AI

Commands

Useful flags

Examples

Next

​Install

​npm

​Binary installer

​Manual (GitHub Releases)

​From source

​Configure

​Quickstart

​Ask AI

​Commands

​Useful flags

​Examples

​Next

Install

npm

Binary installer

Manual (GitHub Releases)

From source

Configure

Quickstart

Ask AI

Commands

Useful flags

Examples

Next