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 CLI globally with npm, then verify the staplehire binary before logging in. 
npm install -g @staplehire/staplehire-cli
staplehire --version
staplehire doctor

​
Prerequisites

RequirementNotes
Node.jsNode.js 18 or newer
npmUsed for global installation
Staplehire accountRequired for staplehire login

​
Install with npm

npm install -g @staplehire/staplehire-cli
The package installs the staplehire binary. 
staplehire --version

​
Install from source

Use source installation only when contributing to the CLI. 
git clone https://github.com/staplehire/staplehire-cli.git
cd staplehire-cli
npm install
npm run build
node bin/staplehire.mjs --version

​
Verify the install

doctor checks the CLI version, API key source, API URL, and GET /v1/me API roundtrip. 
staplehire doctor
staplehire doctor -q
Example JSON output: 
{
  "ok": true,
  "checks": [
    { "name": "CLI Version", "status": "pass", "message": "v0.6.0 (latest)" },
    { "name": "API Key", "status": "pass", "message": "sh_live_...xxxx (source: .env)" },
    { "name": "API URL", "status": "pass", "message": "https://api.staplehire.com" },
    { "name": "API Validation", "status": "pass", "message": "GET /v1/me OK (142ms) - Acme Corp" }
  ]
}

​
FAQ

​
What package do I install?

Install @staplehire/staplehire-cli.

​
What binary does the package provide?

The binary is staplehire.

​
Should CI run staplehire login?

No. Set STAPLEHIRE_KEY as a secret and use staplehire doctor -q to verify it. Related: Authenticate the Staplehire CLI · Use the Staplehire CLI in CI · Command reference