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.
Use staplehire <resource> <action> to run hiring workflows from the terminal. Data commands return JSON on stdout.
staplehire commands | jq '.subcommands[].name'
Run staplehire commands for the live machine-readable command tree for your installed CLI version.
Authentication commands
| Command | What it does |
|---|
staplehire login | Browser PKCE login; writes STAPLEHIRE_KEY to .env |
staplehire logout | Removes STAPLEHIRE_KEY from .env |
staplehire whoami | Verifies the current API key and returns user and organization context |
staplehire init | Deprecated alias for login |
staplehire me | Deprecated alias for whoami |
Roles commands
staplehire roles create --jd <text|@file|->
staplehire roles list [--status <s>] [--q <text>] [--limit <n>]
staplehire roles get <roleId>
staplehire roles candidates <roleId> [--stage-id <id>] [--source <s>]
Candidate commands
staplehire candidates list [--role-id <id>] [--email <e>] [--q <text>] [--limit <n>]
staplehire candidates get <candidateId>
staplehire candidates create <roleId> --email <e> [--name <n>]
staplehire candidates move <candidateId> --stage-id <id>
staplehire candidates enrich <candidateId> [--prompt <text>] [--force]
staplehire candidates research <candidateId>
staplehire candidates screening-result <candidateId>
staplehire candidates send-interview <candidateId> --design <designId> [--mode email|link]
staplehire candidates interview-link <candidateId> --design <designId>
staplehire candidates send-email <candidateId> --subject <s> --title <t> --body <text|@file|->
Sourcing commands
staplehire sourcing start <roleId> [--prompt <text>] [--force]
staplehire sourcing prospects <roleId>
sourcing list is an alias for sourcing prospects.
See Source candidates with the Staplehire CLI.
Interview design commands
staplehire designs create <roleId> [--type <type>] [--brief <text>] [--round-title <title>]
staplehire designs list <roleId>
staplehire designs get <designId>
interview-design is a deprecated alias for designs.
Interview session commands
staplehire sessions list <roleId> [--candidate-email <email>]
interview-sessions is a deprecated alias for sessions.
Stage commands
staplehire stages create <roleId> --name <n> --position <p>
staplehire stages list <roleId>
staplehire stages candidates <roleId> <stageId>
Job commands
staplehire jobs get <jobId>
staplehire jobs list [--role-id <id>] [--candidate-id <id>] [--type <t>] [--status <s>] [--include-history]
staplehire jobs poll <jobId> [--interval <ms>] [--timeout <ms>]
Utility commands
| Command | Description |
|---|
staplehire doctor | Diagnose CLI version, API key, API URL, and API reachability |
staplehire open [path] | Open the Staplehire dashboard |
staplehire docs | Open documentation in the browser |
staplehire update | Check for CLI updates on npm |
staplehire commands | Print the machine-readable command tree |
staplehire skills install | Install the agent skill into Cursor, Claude, and Codex roots |
Global options
| Flag | Description |
|---|
--api-key <key> | Override STAPLEHIRE_KEY for this invocation |
--api-url <url> | Override API gateway base URL |
--app-url <url> | Override dashboard URL for login and open |
--json | Force JSON output in an interactive terminal |
-q, --quiet | Suppress human messages; implies --json |
-h, --help | Show help |
-v, --version | Print version and exit |
--profile <name> | Reserved for multi-profile auth |
Exit codes
| Code | Meaning |
|---|
1 | Generic or internal error |
2 | Authentication, usually 401 |
3 | Validation, usually 400 |
4 | Not found, usually 404 |
5 | Conflict, usually 409 |
6 | Permission, usually 403 |
7 | Upstream, usually 502 |
8 | CLI usage or bad arguments |
9 | jobs poll timeout |
