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.

Install the Staplehire skill so AI agents can discover commands, pass required flags, and consume JSON output safely. 
staplehire skills install
staplehire commands | jq '.subcommands[].name'
staplehire doctor -q

​
Install skills

staplehire skills install
skills install installs the staplehire-cli skill into supported agent roots. 
{
  "installed": true,
  "targets": [
    { "agent": "cursor", "path": "~/.cursor/skills/staplehire", "method": "symlink" }
  ]
}
Use --copy to copy files instead of symlinking, or --dry-run to preview changes.

​
Agent workflow

  1. Install the skill with staplehire skills install.
  2. Discover commands with staplehire commands.
  3. Check auth and API reachability with staplehire doctor -q.
  4. Pass all required flags explicitly.
  5. Poll async jobs before reading generated results.
JOB_ID=$(staplehire sourcing start <roleId> | jq -r '.job.id')
staplehire jobs poll "$JOB_ID" -q
staplehire sourcing prospects <roleId> | jq '.prospects[]'

​
Supported editors

EditorSetup
Cursorstaplehire skills install; run commands in the agent terminal
Claude CodeLoad the installed skill, then use JSON commands
OpenAI CodexUse the same CLI and command tree
OpenClawUse skills plus terminal access
Hermes AgentUse for long-running hiring workflows
PiUse terminal harness plus npm-installed skills

​
Rules for agents

  • Do not use staplehire login in CI or unattended runs.
  • Do not guess role, candidate, design, or job IDs.
  • Prefer staplehire commands over memorized command shapes.
  • Use -q or pipe stdout when a script needs JSON only.
  • After candidates enrich or sourcing start, call jobs poll before reading results.

​
FAQ

​
Can agents run Staplehire without browser login?

Yes. Set STAPLEHIRE_KEY in the environment or pass --api-key for one command.

​
What should an agent do first?

Run staplehire doctor -q. It confirms the CLI version, key source, API URL, and API validation result.

​
How do agents discover command arguments?

Run staplehire commands. It prints the machine-readable command tree as JSON. Related: Authenticate the Staplehire CLI · Poll Staplehire CLI jobs · CLI errors