Docs
siDiscord

Concepts

Every CrabTalk word defined once — account, org, service, tool, call, run, project, plan, credit, request and context.

  • Account: a person's or an org's. It owns services, API keys, apps, a plan and credit, and a handle names it in URLs.
  • Org: an account people share, with owners and members. See Organizations.
  • Service: a Rust program compiled to WebAssembly, with its own SQLite database, deployed to an account and addressed as owner/name. See Development.
  • Tool: a function of a service that takes a JSON object and answers JSON. Its access decides who calls it from outside. See Access.
  • Call: one invocation of a tool. It ends done, failed, denied or refused.
  • Run: one call from outside, a cron or wake firing, or a Stripe event, with the calls it makes to the account's other services. A plan counts runs.
  • Cron and wake: a tool run on a schedule, and a call a service schedules for later. See Crons and wakes.
  • Budget: the most CPU time, rows and memory one call to a tool may use. See Budgets.
  • Secret: a key a service sends to other hosts and never reads, set by a person. See Secrets.
  • Project: the services deployed from one workspace, named after its directory.
  • Plan: what an account's services may use each month, and the limits they run within. See Plans.
  • Credit: money an account buys, which pays for use past a paid plan and for other accounts' priced tools. See Credit.
  • Request: a short code, such as WDJB-MJHT, that an agent hands a person to pay, set secrets, sign a device in, approve a deploy or verify on GitHub. The agent waits on it with crab request <code> --wait.
  • Context: the host crab talks to, Cloud or the local host, with the session it uses there. See Contexts.
  • Local host: CrabTalk's host on your machine, run with crab dev. See Local host.
  • Error code: a code such as E0001 that a refusal names, explained by crab explain. See Errors.