Skip to main content

Documentation Index

Fetch the complete documentation index at: https://staplehire.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Staplehire CLI (staplehire) lets you create roles, source candidates, run research, send interviews, and automate hiring workflows from a terminal. 
npm install -g @staplehire/staplehire-cli
staplehire login
staplehire roles create --jd "Senior backend engineer. TypeScript, remote."
Package: @staplehire/staplehire-cli
Binary: staplehire

​
Start here

Install the Staplehire CLI

Install the package, verify the binary, and run staplehire doctor.

Authenticate the Staplehire CLI

Log in locally or set STAPLEHIRE_KEY for agents and CI.

Source candidates with the Staplehire CLI

Start a sourcing job, poll it, and fetch prospects as JSON.

Send an interview with the Staplehire CLI

Create an interview design and invite a candidate.

​
Common tasks

TaskPage
Install the CLIInstall the Staplehire CLI
Log in or use an API keyAuthenticate the Staplehire CLI
Create a role from a job descriptionCreate a role with the Staplehire CLI
Add a candidate to a roleAdd a candidate with the Staplehire CLI
Source prospectsSource candidates with the Staplehire CLI
Enrich a candidate with researchEnrich a candidate with the Staplehire CLI
Poll async jobsPoll Staplehire CLI jobs
Fix command failuresStaplehire CLI errors
Automate from editorsUse the Staplehire CLI with AI agents

​
Output contract

Every data command writes JSON to stdout. Errors are structured JSON on stderr with stable exit codes, which makes the CLI safe for scripts and AI agents. 
staplehire roles list | jq '.roles[].id'
staplehire doctor -q | jq '.checks[] | select(.status != "pass")'
Related: Command reference · AI agents · CLI errors