Getting started with the SDK
Install @cavuno/board, connect a board, and render your first job board data.
A
JConnect an existing frontend to Cavuno and retrieve live jobs in a few minutes. You can do the setup yourself or install the version-matched instructions that ship with the SDK and hand the implementation to a coding agent.
Before you begin
You need:
- Node.js 20 or later.
- A JavaScript or TypeScript project.
- Your board’s
pk_…publishable key from Settings → Developer → SDK in the Cavuno dashboard. The SDK connects tohttps://api.cavuno.comby default.
The publishable key identifies the board. It is safe to include in browser code, but it does not authenticate a candidate, employer, or Cavuno operator. Never put a board-user bearer token or an operator credential in a public environment variable.
Choose a setup path
| Path | Best when | What you will finish with |
|---|---|---|
| Build with an agent | Your project uses a SKILL.md-compatible coding agent | Version-matched Cavuno instructions installed in the project and a reviewable implementation plan |
| Set up by hand | You want to understand or control every line | A shared client that retrieves the board context and the first page of jobs |
Both paths create the same framework-agnostic client. The agent skills do not add another runtime layer or change the SDK API.
What a successful setup proves
At the end of either path, your application should be able to:
- Resolve
board.context()and display the correct board name. - Resolve
board.jobs.list({ limit: 3 })and display live job cards. - Surface a
BoardApiErrorwhen the API rejects a request instead of replacing the failure with an empty result.
After that, read SDK fundamentals before adding authentication, caching, or a full catalog walk.