@companybook/dealbook

SDK og CLI for Dealbook: lag avtaler, send dem til signering og følg dem fra terminalen eller en agent. Signering skjer på sign.dealbook.no.

CLI

npx -y @companybook/dealbook login     # lim inn nøkkelen fra dealbook.no/konto/nokler
npx -y @companybook/dealbook whoami

Eller installer globalt: npm i -g @companybook/dealbook, så heter kommandoen dealbook.

dealbook validate avtale.json                              # sjekk datalaget
dealbook render avtale.json --body avtale.md               # PDF lokalt
dealbook send avtale.json --pdf avtale.pdf                 # viser mottakerne, sender ingenting
dealbook send avtale.json --pdf avtale.pdf --yes           # sender signeringslenker på e-post
dealbook status <avtale-id>
dealbook document <avtale-id>                              # signert PDF med signaturbevis og segl
dealbook withdraw <avtale-id>                              # viser hvem som får beskjed, endrer ingenting
dealbook withdraw <avtale-id> --yes                        # trekker tilbake; lenkene slutter å virke
dealbook archive <avtale-id>                               # skjuler avtalen; «dealbook restore» henter den tilbake
dealbook draft --pdf avtale.pdf --title "Rammeavtale"      # utkast uten motpart, sender ingenting
dealbook preview <avtale-id>                               # delingslenken: privat med 6-sifret kode
dealbook preview <avtale-id> --open                        # åpen for alle med lenken
dealbook preview <avtale-id> --email [email protected] --yes    # personlig invitasjon på e-post
dealbook send avtale.json --draft <avtale-id> --yes        # send utkastet som samme avtale
dealbook feedback-settings 3fgfa34 --preview on            # la mottakerne kommentere forhåndsvisningen
dealbook feedback 3fgfa34 --unresolved                     # tilbakemeldinger med side og sitat
dealbook feedback-resolve 3fgfa34 <id>                     # marker som løst

Avtale-id er den korte ID-en (7 tegn, f.eks. 3fgfa34) eller UUID-en.

dealbook --help viser alle kommandoer. --json gir maskinlesbar utdata.

Nøkkelen tas aldri som argument. dealbook login leser den fra stdin eller et skjult spørsmål og lagrer den i ~/.config/dealbook/config.json (kun lesbar for deg). DEALBOOK_API_KEY går foran.

SDK

import { DealbookClient } from "@companybook/dealbook";

const dealbook = new DealbookClient({ apiKey: process.env.DEALBOOK_API_KEY! });

const sent = await dealbook.send({
  data,                      // dealbook.agreement/v1 (typen AgreementDataInput)
  pdf,                       // Uint8Array
  fileName: "avtale.pdf",
  idempotencyKey: "min-avtale-1", // samme nøkkel gir samme avtale uten nye e-poster
});

const agreement = await dealbook.get(sent.id);

Feil fra API-et kastes som DealbookError med status, code, message og fields. Krever Node 20 eller nyere.

Claude

Pluginen /dealbook (skill + MCP på mcp.dealbook.no) ligger i 0-1-no/dealbook-plugin.

MIT